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
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
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
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Digital Views
NLP Optimization
ML Engine
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
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
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
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
Masking PII Details
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
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
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
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
Assistant Management
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
  1. Home
  2. Docs
  3. Virtual Assistants
  4. SDKs
  5. BotKit SDK Tutorial – Blue Prism

BotKit SDK Tutorial – Blue Prism

The integration of bots with Blue Prism helps you drive business process automation using conversational flows. 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’s Blue Prism Connector is a generic reference integration for connecting 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 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 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..


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 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 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 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>",
          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:
  • <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.