OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Creating a Simple Bot
SKILLS
Storyboard
Dialog Task
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Overview
Configuring Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub-Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Versioning
Collaborative Development
PLAN & USAGE
Overview
Usage Plans
Support Plans
Invoices
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Creating a Simple Bot
Creating a Banking Bot
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
Update Balance Task
Transfer Funds Task
RELEASE NOTES
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. Define a Card Layout with Group By Report

Define a Card Layout with Group By Report

With some tasks, you may want to add a link to a message sent to a user that contains data too large for a message, for example, a message with a picture, abstract, and a link to a full article or report. This topic describes how to define a card layout with group by report that displays a related set of data groups, for example, a weekly appointment calendar summary.
The card layout with group by report type can be displayed to an end-user when the URL for this report type is clicked in a message. In the following illustration, the message sent to the end-user contains a link to the card layout with group by report called My Calendar Weekly Summary. The message contains the title of the summary report, but not the detailed data.
Group By Calendar Report
When the user clicks the link in the message, a card layout with group by report is displayed with a detailed list of grouped items with a card header, optional card description, and a header row as shown in the following illustration for the My Calendar Weekly Summary report as a list of calendar appointments scheduled for the upcoming week.
Using Group By for the Report
To define a card layout with group by report
To complete the following procedure, you must have already defined a task, such as an alert task, or information task, that you want to add a card layout with group by report link to. Complete the steps in the following procedure to define a card layout with group by report.

  1. In Bot Builder, select the task for the Bot that you want to add a card layout with group by report link to.

    Note: Only unpublished tasks can be modified.

  2. Click the Settings  icon, and then click Edit.
  3. On the Bot Response tab for the task that you want to add a card layout with group by report to, click the Expand  icon for the Report Template Definition section.
  4. In the Link Title field, enter the link text to display to the end-user in the task post, for example, My Calendar Weekly Summary.
  5. In the Header field, enter the title of the report to display when the table report is displayed to the end-user, for example, My Calendar Weekly Summary Report.
  6. In the Details field, optionally enter any end-user help information displayed directly below the Header in the report, for example, Here are the description details for my Today’s Summary card layout report.
  7. In the Template drop-down list, select Card Layout With Group By.
  8. Click Edit Template. The Card Layout Configuration dialog is displayed.
  9. In the Card Title text area, enter your custom JavaScript to display the title data for your card, for example, a static title such as print("Today's Summary Report"); or you can use payload keys, for example, print(summary);.
  10. Click Add Item. The Item Configuration dialog is displayed as shown in the following illustration.
    Card Layout with Group By - Item Configuration Dialog
  11. In the Item Name field, enter the first column title, for example, When.
  12. In the  Data Type field, select one of the following data types for the information displayed in the column:
    1. String
    2. Number
    3. Date
  13. Enable Is a link if the data in the column is a hyperlink. When enabled:
    1. In the Link Label field, enter the JavaScript to display the text for the link, for example, print(date); .
    2. In the URL Value field, enter the JavaScript to display the data to output when the Link Label is clicked, for example, print("https://login.salesforce.com/" + date);
  14. If Is a link is not enabled, then enter the JavaScript to display the value for the column in the Item Value text area, for example,
    if (typeof (date) !== 'undefined') {
     if (date.length > 200) {
     print(date.substr(0, 100) + " ... more");
     } else {
     print(date);
     }
    }
  15. In the Display it as an image section, select Yes if the column value is an image.
  16. In the Display it as HTML section, select Yes if the column value contains HTML content.
  17. In the Group by this column section, click Yes if the report items are to be grouped by this item.
  18. In the Action Payload Key Mapping field, you can display a response key as a link by mapping an action response key, for example, createdDate, to the Item Value field displayed to the end-user as the item When as shown in the previous illustration.
  19. Click Done. The Card Layout Configuration dialog is displayed with the new column added as shown in the following illustration.
    Card Layout with Group By Report - Card Layout Configuration DIalog
  20. Repeat Steps 10 – 19 for each additional column in the report, click Save to save the column configurations, and then click Close.
  21. In the Report Template Definition section, click Save to save the card layout with group by report.

The table is saved Successfully saved response data message is displayed at the top of the page.

Menu
Kore.ai Named a Leader in 2022 Gartner® Magic Quadrant™ for Enterprise Conversational AI PlatformsGet the Report