Skip to main content

Celonis Product Documentation

KPI Card

The KPI Card component enables a deeper understanding of a single KPI value. KPIs are important to quantify performance metrics over time. In comparison to the KPI List component, which displays basic information for several KPIs, the KPI card component allows you to add advanced details on a single KPI.

image3.png

Overview

Placement

Views or Profile View

Required KM objects

KPI

Basic configuration

To configure a basic KPI card, you must have at least the following feature defined.

id:kpi-card-component-1244

type:kpi-card

settings:

    data:

      kpi:undesired_process_steps

Attribute

Required

Type

Description

kpi

true

KPI

References a KPI defined in the Knowledge Model.

Advanced configuration

In addition to the basic configuration, the following configuration options are also available.

id:kpi-card-component-1244

type:kpi-card

settings:

data:

kpi:undesired_process_steps

description:

value:The {0} happens in {3} ({2}) of cases. In total, it happens {1} times. On average it happens {4} times per case.

placeholders:

-field:unwanted_activity

-field:undesired_process_steps

-field:number_of_cases_with_undesired_process_steps

-field:new_unwanted_activity_rate

-field:occurrences_of_undesired_process_steps_per_case_affected_

relatedKpis:

-kpi:throughput_time_with_activity

-kpi:impact_on_median_throughput_time

trend:

timeDimension:CEL_AP_ACTIVITIES.EVENTTIME

range:day

growthRates:true

options:

showTarget:true

showPriority:true

swapTitle:false

Attribute

Required

Type

Possible values

Description

description

value:

placeholders:

- field:

false

String

-

Defines description/supporting text that is displayed below the KPI value. You can also define attributes, KPIs, or variables from your knowledge model that you want to reference in this text. Once these have been defined in your parameter configuration, you can use them by referencing them using the format "Placeholder {X}" where "X" is the order placement you listed it in.

Note

When referencing the parameter in the text field, the ordering reference should start at {0}. If you have three fields listed, you can reference these as :

  • Placeholder {0}

  • Placeholder {1}

  • Placeholder {2}

relatedKPIs:

  • kpi:

false

KPI

Define related KPIs to be displayed on the KPI card component. These KPIs should be used to support the main KPI with additional metrics.

image2.png

trend:

timeDimension:

range:

growthRates:

false

Defines if trend visualizations should be displayed on the KPI card component. Trends can be added to gauge how your KPI has been trending across the selected time period. There are two types of trend visualizations that can be added

  • General trend marker: The general trend marker displays the percentage of change in the KPI value (also known as slope). You must define the time dimension (i.e. invoice date, closing date, etc.) and range (daily, weekly, monthly, or yearly) that the trend is calculated over. Once these are defined, a badge will be added to show the average increase or decrease per time period defined.

Note

The column type must be defined for the time dimension. Date and Time are the only valid data types.

image4.png
image7.png
  • Year of Year (YoY)/Month of Month (MoM) growth trends:These are additional trend details that can be added by setting “growthRates: true”. These will be displayed based on available data,

image1.png
image6.png

Note

The calculations will always take into account the latest two full periods of data. For example, if you access your view on June 12th, 2022, you will only send MoM trends if you have data for April and May 2022 and YoY if you have data for 2020 and 2021. It will always be calculated as :

((Last period - Second to last period)/Second to last period)x100

showTarget

false

Boolean

true

false

Defines if target information is displayed. Target information will only be displayed if the data is available. A red/green target icon will display next to this target based on how you are currently tracking towards your target.

image5.png

Note

Target values can only be set in the settings modal from the KPI list user interface. To enable the interface, set showSettings to true in a KPI List component with the same KPI defined, and click on the gear icon.

shorwPriority

false

Boolean

true

false

Defines if priority information is displayed. Priority information will only be displayed if the data is available.

Note

Note: Priority selection can only be set using the priority switcher tool and must be first added to your view to use it. For details on how to set this up, see Views Tools.

displayContentRule

false

String

-

References a Display Rule in the Knowledge Model.

kpiParams

  • id

value

false

Views Variables

-

Defines parameters that are also used in the Knowledge Model. For details on how to set a KPI parameter in the KPI, see KPI List

The ID value defines the ID value of the parameter defined. The ID value must match the KPI parameter ID defined in KM to work correctly.

Thevaluedefines the parameter that will be passed from the knowledge model. This value should be defined using a variable with the input coming from e.g. a dropdown component.