KPI Bowler
Overview
Introduction to KPI Bowler
Use the "KPI Bowler" component on (Profile) Views to allow your users to define and track the progress of their KPIs over time.
The PQL queried values are automatically compared to the targets and indicate by color whether the target was reached or not. The desired direction of a KPI is defined in the Knowledge Model.
![]() |
Basic configuration
To configure a KPI Bowler, you must have at least the following features defined. Ensure that prior to creating a new KPI Bowler component, you have all data you wish to include in the table properly defined in the Knowledge Model. Additional links on links on setting these fields up can be found in the table below.
Attribute | Required | Type | Description |
---|---|---|---|
mainAttribute | true | Record.Attribute | A record defined in the Knowledge Model defining the rows of the Bowler (Example: COUNTRIES) |
firstKpi | true | KPI | A KPI to be shown as columns defined in the Knowledge Model (Example: THROUGHPUT_TIME) |
pivotAttribute | true | Record.Attribute | The dimension for the rows of the bowler. Usually time steps. (Example: ROUND_WEEK) |
Info
optimised for component editor
id: kpiBowler type: kpi-bowler settings: data: mainAttribute: INVOICE.CUSTOMER_BUSAB_TEXT firstKpi: KPI_COLLECTED_AMOUNT pivotAttribute: INVOICE.ENTRY_QUARTER
Advanced configuration
Further additional configuration options are available:
Attribute | Required | Type | Possible values | Default Value | Description |
---|---|---|---|---|---|
name | false | Boolean | true false | false | Defines the headline of the component. |
goal | false | Double | Defines the default goal of all KPIs. | ||
limit | false | Integer | Defines how many rows should be displayed per page. | ||
secondKpis | false | Defines a list of second KPIs which will be rendered in the KPI bowler. | |||
manualTarget | false | Boolean | true false | false | Defines if a target can be manually entered by the end user. |
breakdowns | false | Custom attributes | Defines the breakdown dimensions which are displayed above the table. The user can then toggle between the different attributes defined in the custom attribute. | ||
link | false | Boolean | true false | false | Defines if the mainAttribute becomes clickable to open a Profile View . To make it fully work create a separate Profile View of the same knowledgeObjectId. |
displayContentRule | false | Custom attributes | To underline the status of your KPIs with visual clues, you can add custom Display Rulesto the component. To realize the custom Display Rules, a Knowledge Model element of type customObject needs to be defined in the Knowledge Model of your view. Click here to see exampleKnowledge Model customObjects: - id: KPI_BOWLER_PERCENTAGE displayName: KPI Bowler percentage customAttributes: - comparator: GREATER_THAN_OR_EQUAL # value in percentage value: 90 style: textColor: "#7DBB00" backgroundColor: "rgba(125,187,0,0.5)" - comparator: BETWEEN value: [ 90, 50 ] style: textColor: "#FF7000" backgroundColor: "rgba(255,112,0,0.5)" - comparator: BETWEEN # value in percentage value: [ 51, 10 ] style: textColor: "#52618F" backgroundColor: "rgba(82,97,143,0.5)" - comparator: LESS_THAN_OR_EQUAL # value in percentage value: 10 style: textColor: "#ff0000" backgroundColor: "rgba(255,0,0,0.5)" NoteThe value of a comparator needs to be a percentage and not an absolute value. A value of "100 %" would equal to "target reached". |
Info
optimised for component editor
id: advanced-kpi-bowler type: kpi-bowler settings: name: Team Overview data: mainAttribute: INVOICE.CUSTOMER_BUSAB_TEXT pivotAttribute: INVOICE.ENTRY_QUARTER firstKpi: KPI_COLLECTED_AMOUNT manualTarget: true link: true goal: 50 limit: 10 breakdowns: MAIN_BREAKDOWNS displayContentRule: KPI_BOWLER_COLOR_RULE secondaryKpis: - AVERAGE_NETWR_CONVERTED - COUNT_TABLE__PIZZAP2P_XLSX_SHEET_0