> For the complete documentation index, see [llms.txt](https://help.novacuraflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.novacuraflow.com/6.11/development/flow-portal-2/portlets/kpi-portlets/kpi-1.md).

# KPI card

The KPI cards allows for a quick view of a specific value. To alert users,  KPI cards can be configured to show specific colors based on setup rules.

## General

General data is required for all portlets.

[General configuration](/6.11/development/flow-portal-2/portlets/common-configuration.md#general)

## Listeners

The portlet can listen to the following commands:

* On Row Selection
* On Refresh

[Listeners configuration](/6.11/development/flow-portal-2/portlets/common-configuration.md#listeners)

## Data

### Data source

The portlet data source configuration enables the portlet to execute specified queries towards the chosen database connector to fetch data, or fetch data from a workflow.

* Database: uses a flow connector to retrieve data from a database
* Workflow: runs a workflow to retrieve data

[Data source configuration](/6.11/development/flow-portal-2/portlets/common-configuration.md#database-source)

[Workflow source configuration](/6.11/development/flow-portal-2/portlets/common-configuration.md#workflow-source)

### Presentation

Under presentation, add the data which is to be shown in the KPI card:

* Value: the value which is to be displayed as the main information in the portlet
* Unit: the unit of the value
* Description: the description to describe the value

<div align="left"><img src="/files/-M0Yxvk4OtKyFTD-q7DZ" alt=""></div>

<div align="left"><img src="/files/-M0YpJD8x8n4IfCg1P_Q" alt=""></div>

## Background color rules

The KPI card can have one or more color rules, for example to be used to make the background color change to indicate the value is below or above a certain threshold.&#x20;

To enter a new rule:&#x20;

* click *New*
* select a color
* enter the condition field, operator and value
* preview the result or save&#x20;

To edit an existing rule, click on the rule and it expands into edit mode.&#x20;

<div align="left"><img src="/files/-M0Yp8EiQPG0zn7zZxnt" alt=""></div>

## Text color rule

The color of the presentation, value, and description can be configured under *text color rules*.

To enter a new rule:&#x20;

* click *New*
* select a color
* enter the condition field, operator, and value&#x20;
* preview the result or save

To edit an existing rule, click on the rule and it expands into edit mode.&#x20;

<div align="left"><img src="/files/-M0Yucr2FSYnWkX8S4rd" alt=""></div>

## Style

Change the header text color and add a header stripe by configuring style.

[Style configuration](/6.11/development/flow-portal-2/portlets/common-configuration.md#style)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.novacuraflow.com/6.11/development/flow-portal-2/portlets/kpi-portlets/kpi-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.