Skip to main content

Boards

Overview​

Boards in Veezoo are custom dashboards that display selected data insights through various types of visualizations. They provide a structured and interactive view of your data, which is particularly useful for monitoring key metrics, performing high-level data analysis, and presenting data insights.

A board can be created over the Chat UI or defined through a board declaration containing one or more widgets. Each widget represents a data insight, typically in the form of a question, displayed in a specific visualization format.

qb {
    board Sales_Analysis {
        name.en: "Sales Analysis"
        
        for_user_role: "Sales Manager"
        
        widget Revenue_Overview {
            name.en: "Revenue per Category"
            
            board_row: 0
            board_column: 0

            height: 3
            width: 6

            question.en: "Revenue per category this year"
            visualization: BarChart
        }
        
        widget Sales_Trends {
            name.en: "Sales Trends"
            
            board_row: 0
            board_column: 6

            height: 3
            width: 6

            question.en: "Revenue per month this year"
            visualization: LineChart
        }
    }
}

Advantages of defining as VKL code​

By defining it as VKL code, you can:

  • collaborate more easily with other team members
  • have it version controlled
  • because it is based on questions, it evolves more naturally with the changes to your schema without you having to adapt it
  • see in one view how it is defined

How to create it​

To create a board, open Studio and click to create a new Board file in the Sidebar. When the modal appears, give it a name, e.g. Board.

Studio Sidebar

Switch to the file view on the sidebar so you can explore the boards you defined.

Studio Sidebar

Check the documentation below for more information on how to define your Board experience.

VKL Structure​

Here's a brief overview of the structure of the VKL file with the Board definition:

  • board: The highest level of grouping in the board. Each board contains several widgets.
  • widget: Each widget represents a data insight displayed in a specific visualization format.

Each of these elements has several properties:

board​

  • name: The name of the board, displayed to the users.
  • for_user_role: (Optional) A user role with which the board is shared. If not set, the board is shared with all users.
info

Depending on whether for_user_role is set, VKL boards are shared with a given list of roles or the whole organization. In both cases, they are added to all users' sidebars by default. See here for more details about shared boards.

widget​

  • name: The name of the widget, displayed to the users.
  • board_row: The row number where the widget is displayed on the board.
  • board_column: The column number where the widget is displayed on the board. Defined between 1 and 12.
  • height: The height of the widget.
  • width: The width of the widget, between 1 and 12.
  • question: The data insight that the widget displays.
  • visualization: The type of visualization used to display the data insight.

visualization​

This is the type of visualization used to display the data insight. You can set this for every widget. If unset, Veezoo chooses the most appropriate visualization. You can choose from a number of available charts:

AreaChart
MultiAreaChart
StackedAreaChart
PercentStackedAreaChart

BarChart
MultiBarChart
StackedBarChart
PercentStackedBarChart

ColumnChart
MultiColumnChart
DrillDownColumnChart
MultiDrillDownColumnChart
StackedColumnChart
PercentStackedColumnChart

PieChart
DrillDownPieChart

LineChart
MultiLineChart
MultiAxesLineChart
RangeMultiLineChart

BubbleChart
MultiBubbleChart
LabeledMultiBubbleChart

ScatterChart
MultiScatterChart
LabeledMultiScatterChart

TreeMap

ChoroplethMap

HeatMatrixChart

TableChart

SimpleNumberChart
TwoNumberChart
NumberComparisonChart

Example​

Here is an example of how a board can be structured in Veezoo:

qb {
    board Sales_Analysis {
        name.en: "Sales Analysis"
        
        for_user_role: "Sales Manager"
        
        widget Revenue_Overview {
            name.en: "Revenue per Category"
            
            board_row: 0
            board_column: 0

            height: 3
            width: 6

            question.en: "Revenue per category this year"
            visualization: BarChart
        }
        
        widget Sales_Trends {
            name.en: "Sales Trends"
            
            board_row: 0
            board_column: 6

            height: 3
            width: 6

            question.en: "Revenue per month this year"
            visualization: LineChart
        }
    }
}

In this example, there's a Sales Analysis board designed for the "Sales Manager" role. It contains two widgets: Revenue Overview displaying total revenue by product category this year as a BarChart, and Sales Trends showing the sales trend over the past year as a LineChart. The board_column, board_row, height, and width properties define the placement and size of each widget on the board.

Boards in Veezoo offer a robust and user-friendly way to present your data insights. By combining multiple related widgets into one dashboard, you can create a comprehensive and visually appealing overview of your data.