---
tags:
- UI Page widgets
alias: user-guide-uipage-widgets-entity-kpi
widgetname: Entity KPIs
description: "This documentation details configuring a widget displaying entity key performance indicators and their associated data"
---

# Entity KPIs

![entity_kpi_icon][entity_kpi_icon]

## Overview

The Entity KPIs widget displays information on **KPIs** of a given entity instance in a grid or tile format, with specific **KPIs** as headers.

![entity_kpi_view][entity_kpi_view]

## General Steps

{% include-markdown 'includes/pages/ui_widgets_general_steps.md' %}

![entity_kpi_general][entity_kpi_general]

## Widget Customization

1. Optionally, in the **Style** tab, you can define a Border Width and Color.

    ![Screenshot showing the Entity KPIs settings in the Style tab of the widget customization interface.](images/entity_kpi_style.png)

2. In the **Setup** tab, provide visualization and data related properties, such as:

    * **Entity Type** - Select the primary Entity Type to be used for the KPI calculation.
    * **Show Entity Name** - Choose whether to display the entity name. This option is set to `true` by default.
    * **Display Mode** - Choose how the KPIs will be displayed, either in Tiles or Grid mode.
    * **Grid Row Height Mode** - Determine if the widget should dynamically adjust the row height based on the data (Dynamic) or keep it fixed (Static).
    * **Grid Selection Mode** - Select the grid's selection mode: None, Single, or Multiple.
    * **Category** - Choose a specific category within the selected Entity Type to further refine the KPI calculation.
    * **Auto Refresh** - Choose whether the data should refresh periodically. If enabled, define the interval for each automatic refresh. This option is set to `true` by default.

    ![entity_kpi_setup][entity_kpi_setup]

3. Define the **KPIs** to be displayed in the widget. Add as many **KPIs** as desired (press :material-plus: in the top right of the grid to add, and :material-trash-can: to remove), providing for each item the following information:

    * **KPI** - Select the **KPI** that has been predefined in your MES system.
    * **Name** - The name of the **KPI** will be automatically populated once you select the **KPI**.
    * **Dimension** - Specify the dimension associated with the selected **KPI**. The available dimensions will depend on the chosen **KPI**.
    * **Gauge Type** - Choose the type of gauge to represent the **KPI**. The options for gauge types will vary based on the selected **KPI**.
    * **Decimal Places** - Set the number of decimal places to be displayed for the **KPI** value.

    !!! info
      	For more information on available **KPIs**, see the [[tutorials-bicards]].

    ![entity_kpi_kpi][entity_kpi_kpi]

4. Optionally, define the **Links** between this widget and other elements of the UI Page.

    ![entity_kpi_links][entity_kpi_links]

5. By saving and closing the settings, the widget will be changed accordingly.

[entity_kpi_icon]: images/entity_kpi_icon.png
[entity_kpi_view]: images/entity_kpi_view.png
[entity_kpi_general]: images/entity_kpi_general.png
[entity_kpi_setup]: images/entity_kpi_setup.png
[entity_kpi_kpi]: images/entity_kpi_kpi.png
[entity_kpi_links]: images/entity_kpi_links.png