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
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Kore.ai XO GPT Model
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
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
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
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
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. Form Node

Form Node

The Form node lets you integrate Digital Forms with Dialog Tasks. This facilitates the presentation of forms to capture user inputs for specific use cases.

The primary purpose of the Form node is to represent a UI Form in the dialog task and make the form available for end-users on their channel. For example, let us consider a travel assistant that has a form to capture the customer details to make a new booking. During this process, you may want to use the form instead of prompting for each and every entity value.

Add the Node

Before you can begin setting up a Form node, you need to have previously created a Digital Form to use within the node. 

To add a form node to the dialog task, follow the below steps:

  1. Open the dialog task to which you want to add the Form node.
  2. Add the Form node in the designated place. To learn how to add nodes, please click here. You will be shown a list of existing Digital Forms from which you can choose the one to add to this node.
  3. Choose the channels on which you want to offer the form experience.
  4. Choose the Form Experience: If you are offering your Virtual Assistant on multiple channels, you can choose whether to enable the Digital Form Experience as the default experience on all these channels, or use a combination of Digital Form Experience and Conversation Experience.
    1. Only UI Form: Users will be presented the Digital Form Experience on all the channels that are enabled for the assistant that you are working with. This will create a Form Node and automatically open the Component Properties panel, where you can continue configuring the node.
    2. Both Digital Form and Conversational Experience: You can choose the channels on which the Digital Form Experience should be enabled and all other channels will use the Conversational Experience.
  5. By following this process, the Platform will automatically add a Form Experience Transition (Bot Action) node group, which ramifies into the necessary Dialog Task and Form Node, to allow you to further customize the Form Experience and Conversation Experience for your channel selection. This Transition is composed of individual nodes, which you will need to configure separately, according to their respective node types.

Configure the Node

This configuration applies to the Form Node Type – regardless of whether it is standalone by selecting Only UI Form during setup, or whether it is part of a Form & Conversation Experience.

Component Properties

Note: The configurations you set up or modify in this section are reflected in all other dialog tasks that use this node.

The Form Component Properties allow you to configure a variety of settings and prompts related to your Form Node, as follows: 

  1. On the Component Properties tab, under the General Settings section, enter a Name and Display Name for the form node. Node names cannot contain spaces, but the Display Name can.
  2. In the User Prompts  text box, enter the prompt message that you want the user to see for this form. It should instruct the user to click on the link to initiate the form. It is not recommended to change the context variable reference (of the form {{context.form_node.formLink}})coded therein. You can enter channel-specific messages for user prompts. For more information, refer to Using the Prompt Editor.
  3. In the Error Prompts text box, review the default error message, and if required modify it. For more information, refer to Using the Prompt Editor.
  4. In the Submit Prompts text box, review the default message that is displayed after successful submission of the form, and if required, modify it. This message is applicable only when the UI Form is opened in a browser tab.
    Steps to personalize form submission prompt for Mobile/Web SDK:

    1. Under Submit Prompts, click Add a prompt.
    2. In the additional prompt editor, select Web/Mobile Client.
    3. Write or change the message as appropriate.

      For more information, refer to Using the Prompt Editor.

  5. Under the Web/Mobile SDK Form Behavior section, you can set how the form is displayed. You can select:
    • Open full page popup form – This is the default setting where the form opens as a full page on the SDK chat interface.
    • Open inline form – The form opens as an inline form within the chat window.
  6. Under Advanced Controls section, you can choose the submit prompt to show for Web/Mobile SDK and select how the VA handles the conversation when the user cancels the form.
    • In the Submit Prompts for Web/Mobile SDK section, select the prompt to show on successful form submission. The options are:
      a. Use Submit Prompts –  The custom message added in the prompt is shown.
      b. Use default system response –  The following confirmation is shown – {{FormName}} Form is successfully submitted.
    • In the Form Cancellation Behavior section, select how the VA handles the conversation when the user cancels the form:
      a. Discard the task and trigger End of Task Event – This is the default option.

      b. Continue with this task and transition to this node – In the Select Node drop-down list, you can select any node present in the current dialog task.

    Note: The target node has to be in the same dialog, you cannot make a jump to a target node outside the current dialog. The list of target nodes only shows the local nodes. If the target node is not present during runtime, the platform presents the error Error in continuing the conversation, and the task should get discarded.

Instance Properties

Use the Instance Properties to define any user tags that you want to set.

Note: The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in other dialog tasks that use this form node.

To configure this tab, please follow these steps:

  1. On the Form window, click the Instance Properties tab.
  2. Under the Custom Tags section, add tags to build custom profiles of your conversations. Click here for more. 

Connections Properties

From the node’s Connections tab, you can determine the node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.

Note: These conditions are applicable only for this instance and will not affect the node when being used in any other dialog.

 

For details on how to work with connection conditions, please see Adding IF-Else Conditions to Node Connections. 

Form Node

The Form node lets you integrate Digital Forms with Dialog Tasks. This facilitates the presentation of forms to capture user inputs for specific use cases.

The primary purpose of the Form node is to represent a UI Form in the dialog task and make the form available for end-users on their channel. For example, let us consider a travel assistant that has a form to capture the customer details to make a new booking. During this process, you may want to use the form instead of prompting for each and every entity value.

Add the Node

Before you can begin setting up a Form node, you need to have previously created a Digital Form to use within the node. 

To add a form node to the dialog task, follow the below steps:

  1. Open the dialog task to which you want to add the Form node.
  2. Add the Form node in the designated place. To learn how to add nodes, please click here. You will be shown a list of existing Digital Forms from which you can choose the one to add to this node.
  3. Choose the channels on which you want to offer the form experience.
  4. Choose the Form Experience: If you are offering your Virtual Assistant on multiple channels, you can choose whether to enable the Digital Form Experience as the default experience on all these channels, or use a combination of Digital Form Experience and Conversation Experience.
    1. Only UI Form: Users will be presented the Digital Form Experience on all the channels that are enabled for the assistant that you are working with. This will create a Form Node and automatically open the Component Properties panel, where you can continue configuring the node.
    2. Both Digital Form and Conversational Experience: You can choose the channels on which the Digital Form Experience should be enabled and all other channels will use the Conversational Experience.
  5. By following this process, the Platform will automatically add a Form Experience Transition (Bot Action) node group, which ramifies into the necessary Dialog Task and Form Node, to allow you to further customize the Form Experience and Conversation Experience for your channel selection. This Transition is composed of individual nodes, which you will need to configure separately, according to their respective node types.

Configure the Node

This configuration applies to the Form Node Type – regardless of whether it is standalone by selecting Only UI Form during setup, or whether it is part of a Form & Conversation Experience.

Component Properties

Note: The configurations you set up or modify in this section are reflected in all other dialog tasks that use this node.

The Form Component Properties allow you to configure a variety of settings and prompts related to your Form Node, as follows: 

  1. On the Component Properties tab, under the General Settings section, enter a Name and Display Name for the form node. Node names cannot contain spaces, but the Display Name can.
  2. In the User Prompts  text box, enter the prompt message that you want the user to see for this form. It should instruct the user to click on the link to initiate the form. It is not recommended to change the context variable reference (of the form {{context.form_node.formLink}})coded therein. You can enter channel-specific messages for user prompts. For more information, refer to Using the Prompt Editor.
  3. In the Error Prompts text box, review the default error message, and if required modify it. For more information, refer to Using the Prompt Editor.
  4. In the Submit Prompts text box, review the default message that is displayed after successful submission of the form, and if required, modify it. This message is applicable only when the UI Form is opened in a browser tab.
    Steps to personalize form submission prompt for Mobile/Web SDK:

    1. Under Submit Prompts, click Add a prompt.
    2. In the additional prompt editor, select Web/Mobile Client.
    3. Write or change the message as appropriate.

      For more information, refer to Using the Prompt Editor.

  5. Under the Web/Mobile SDK Form Behavior section, you can set how the form is displayed. You can select:
    • Open full page popup form – This is the default setting where the form opens as a full page on the SDK chat interface.
    • Open inline form – The form opens as an inline form within the chat window.
  6. Under Advanced Controls section, you can choose the submit prompt to show for Web/Mobile SDK and select how the VA handles the conversation when the user cancels the form.
    • In the Submit Prompts for Web/Mobile SDK section, select the prompt to show on successful form submission. The options are:
      a. Use Submit Prompts –  The custom message added in the prompt is shown.
      b. Use default system response –  The following confirmation is shown – {{FormName}} Form is successfully submitted.
    • In the Form Cancellation Behavior section, select how the VA handles the conversation when the user cancels the form:
      a. Discard the task and trigger End of Task Event – This is the default option.

      b. Continue with this task and transition to this node – In the Select Node drop-down list, you can select any node present in the current dialog task.

    Note: The target node has to be in the same dialog, you cannot make a jump to a target node outside the current dialog. The list of target nodes only shows the local nodes. If the target node is not present during runtime, the platform presents the error Error in continuing the conversation, and the task should get discarded.

Instance Properties

Use the Instance Properties to define any user tags that you want to set.

Note: The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in other dialog tasks that use this form node.

To configure this tab, please follow these steps:

  1. On the Form window, click the Instance Properties tab.
  2. Under the Custom Tags section, add tags to build custom profiles of your conversations. Click here for more. 

Connections Properties

From the node’s Connections tab, you can determine the node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.

Note: These conditions are applicable only for this instance and will not affect the node when being used in any other dialog.

 

For details on how to work with connection conditions, please see Adding IF-Else Conditions to Node Connections. 

Menu