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
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. SDKs
  5. BotKit SDK Tutorial – Blue Prism

BotKit SDK Tutorial – Blue Prism

The integration of Kore.ai bots with Blue Prism helps you drive business process automation using conversational flows. Kore.ai bots execute conversation flows by understanding user intents, entities, context, and sentiment. Blue Prism RPA services can consume the contextually relevant information and effectively automate business processes.

Integration Approach

Kore.ai’s Blue Prism Connector is a generic reference integration for connecting Kore.ai bots with your enterprise Blue Prism RPA services. Conversation flow can be defined to invoke RPA services using Webhook nodes via BotKit SDK integration. The following is a typical integration flow:

  • Conversation flows in Kore.ai bots can be configured to pass the contextually relevant information like intent in progress, entities collected, etc. to the BotKit SDK (platform extension)
  • BotKit SDK can be used to invoke the RPA process using the Kore.ai Blue Prism Connector.
  • The connector invokes the specified RPA process on Blue Prism and returns the response back to the platform.
  • Response from RPA service can be used in defining bot definitions like dialog transitions, entity determination, end-user responses, etc..

Prerequisites

Before you begin, ensure that you have completed the following necessary steps:

  • Signup for Blue Prism’s RPA platform and define your automation flows.
  • Download Kore.ai BotKit SDK from here,  review and update integration details of your Blue Prism instance in the BluePrismConnector.js file.
  • Enable RPA services on the Blue Prism platform to start communicating with your Kore.ai bots.

Steps in Integration

Following are the steps in integrating Blue Prism with your bot:

  • Step 1: Create a Dialog task and build flow to meet your business use case
  • Step 2: Identify the specific locations in your flow that require integration with Blue Prism to invoke RPA services
  • Step 3: Build your RPA service request JSON object (BluePrismRequest) using Script nodes (refer here for how). Refer to the ‘Sample Request Object‘ section given below for a sample representation.
  • Step 4: Place Webhook nodes in the identified locations. Ensure that you have setup BotKit SDK and configured the connections. Refer here for more details on Webhook Node.
  • Step 5: Review the request payload that the Kore.ai platform passes to BotKit for invoking the RPA service.
  • Step 6: Response payload (BluePrismResponse) received from RPA services is now available in the dialog context. You can use the data from the BluePrismResponse object to compose a response to the user or define conversation flows of your bot.

Sample Request Object

The information required for invoking the RPA services has to be populated following the structure provided in this section. On reaching the Webhook node in the conversation, the information required for invoking the RPA services is forwarded to the BotKit by the platform which in turn would make the call to the RPA service.

The request payload should include the following information.

 var bluePrismRequest = {};

  bluePrismRequest= {
     "url" : "<service endpoint for process>",
     "operation" : "<RPA Process Name>",
     "attributes":{
          UserInput1 :"<input1>",
          UserInput2 : "<input2>",
            ……..
        }
  }
Parameter Type Description
operation String Name of the RPA Process created
url URL Service endpoint of the RPA process
attributes Blue Prism supported Data Types Data inputs needed to run the RPA Process

Responses from Blue Prism

Response from Blue Prism services is received by the BotKit SDK and then it is passed on to your bot’s dialog task. The response is stored in the context object against the predefined key ‘ResponseFromBluePrism. You may configure Blue Prism services to respond either in ‘sync‘ or ‘async‘ modes. In the case of ‘async’ mode, your Blue Prism services should call the following URL to post the response: http://<host>/sdk/blueprismConnector/:<requestId>

  • <host> refers to the environment of your bots. Example: bots.kore.ai
  • <requestId> refers to the unique reference number associated with the request made to the Blue Prism service from your bots

Post processing the Webhook node, the platform will resume the task from that point forward and the dialog will be executed as per the regular conversation flow. As the Blue Prism response is present in the dialog’s context, you may use it for defining conversation flows, customizing responses to the end users, etc.

BotKit SDK Tutorial – Blue Prism

The integration of Kore.ai bots with Blue Prism helps you drive business process automation using conversational flows. Kore.ai bots execute conversation flows by understanding user intents, entities, context, and sentiment. Blue Prism RPA services can consume the contextually relevant information and effectively automate business processes.

Integration Approach

Kore.ai’s Blue Prism Connector is a generic reference integration for connecting Kore.ai bots with your enterprise Blue Prism RPA services. Conversation flow can be defined to invoke RPA services using Webhook nodes via BotKit SDK integration. The following is a typical integration flow:

  • Conversation flows in Kore.ai bots can be configured to pass the contextually relevant information like intent in progress, entities collected, etc. to the BotKit SDK (platform extension)
  • BotKit SDK can be used to invoke the RPA process using the Kore.ai Blue Prism Connector.
  • The connector invokes the specified RPA process on Blue Prism and returns the response back to the platform.
  • Response from RPA service can be used in defining bot definitions like dialog transitions, entity determination, end-user responses, etc..

Prerequisites

Before you begin, ensure that you have completed the following necessary steps:

  • Signup for Blue Prism’s RPA platform and define your automation flows.
  • Download Kore.ai BotKit SDK from here,  review and update integration details of your Blue Prism instance in the BluePrismConnector.js file.
  • Enable RPA services on the Blue Prism platform to start communicating with your Kore.ai bots.

Steps in Integration

Following are the steps in integrating Blue Prism with your bot:

  • Step 1: Create a Dialog task and build flow to meet your business use case
  • Step 2: Identify the specific locations in your flow that require integration with Blue Prism to invoke RPA services
  • Step 3: Build your RPA service request JSON object (BluePrismRequest) using Script nodes (refer here for how). Refer to the ‘Sample Request Object‘ section given below for a sample representation.
  • Step 4: Place Webhook nodes in the identified locations. Ensure that you have setup BotKit SDK and configured the connections. Refer here for more details on Webhook Node.
  • Step 5: Review the request payload that the Kore.ai platform passes to BotKit for invoking the RPA service.
  • Step 6: Response payload (BluePrismResponse) received from RPA services is now available in the dialog context. You can use the data from the BluePrismResponse object to compose a response to the user or define conversation flows of your bot.

Sample Request Object

The information required for invoking the RPA services has to be populated following the structure provided in this section. On reaching the Webhook node in the conversation, the information required for invoking the RPA services is forwarded to the BotKit by the platform which in turn would make the call to the RPA service.

The request payload should include the following information.

 var bluePrismRequest = {};

  bluePrismRequest= {
     "url" : "<service endpoint for process>",
     "operation" : "<RPA Process Name>",
     "attributes":{
          UserInput1 :"<input1>",
          UserInput2 : "<input2>",
            ……..
        }
  }
Parameter Type Description
operation String Name of the RPA Process created
url URL Service endpoint of the RPA process
attributes Blue Prism supported Data Types Data inputs needed to run the RPA Process

Responses from Blue Prism

Response from Blue Prism services is received by the BotKit SDK and then it is passed on to your bot’s dialog task. The response is stored in the context object against the predefined key ‘ResponseFromBluePrism. You may configure Blue Prism services to respond either in ‘sync‘ or ‘async‘ modes. In the case of ‘async’ mode, your Blue Prism services should call the following URL to post the response: http://<host>/sdk/blueprismConnector/:<requestId>

  • <host> refers to the environment of your bots. Example: bots.kore.ai
  • <requestId> refers to the unique reference number associated with the request made to the Blue Prism service from your bots

Post processing the Webhook node, the platform will resume the task from that point forward and the dialog will be executed as per the regular conversation flow. As the Blue Prism response is present in the dialog’s context, you may use it for defining conversation flows, customizing responses to the end users, etc.

Menu