Tables

Last Updated: 25.10.2019

Overview

With Hala, you can include the table in the response. It can be useful when you are making an API request to external application, and then you want to represent the API response in the table view for the user. Also, you can use tables with mockup data, if you need to represent the information with columns and lines.

For example:

Adding the tables in Expert mode

You can use the expert mode to add the tables. The expert mode becomes available by pressing the button next to the word "Output."

Access the Expert mode

Here is the JSON format for the tables that generated based on the API response:

[
{
"type": "table",
"view": "horizontal",
"name":"Example table",
"filters": {
"Country": [
"Estonia"
]
},
"sourceData": "{{context.responseFromAPI}}",
"requiredFields": [
"Country",
"Company",
"Address",
"Phone number",
"Email"
],
"transformFromDb": true
}
]

Example for the table with mockup data:

{
"type": "table",
"view": "horizontal",
"name": "Table name",
"transformFromDb": false,
"sourceData": [{
"Country": "Estonia",
"Company": "Hala Digital OU",
"Address": "Erika 14",
"Phone number": "+37259823235",
"Email": "rudchuk@hala.ai"
}, {
"Country": "Latvia",
"Company": "Hala Digital SIA",
"Address": "Puces 10",
"Phone number": "+37259823235",
"Email": "support@hala.ai"
}]
}

The views of the table in the chat based on mockup data above:

The following table describes the parameters that can be used to build the table:

Parameter

Type

Description

type

string

String value, specifying the format.

view

string

View of the tables. horizontal - columns are displayed horizontally. vertical - columns are displayed vertically

name

string

Optional. The name of your table that is displaying for the user in output.

filters

array

Optional. Array with Objects. Each object represents a filter. The key of the Object denotes the field that should be filtered, and the Array of Strings represents the criteria.

sourceData

array

Array with all the data records to be displayed in the Table. It can be described as {{context.context_name}} or with the mockup data.

requiredFields

array

Optional. Array with String values representing the keys that the table should use to populate the columns. If it is empty, the SmartTable will use the first five fields in the "sourceData" object.

transformFromDb

boolean

A boolean value indicating if the keys in the "sourceData" objects should be replaced with longer and more explicit ones from the database (API response), if set false, the keys will be shown in the columns of the table just as they are.

‚Äč