QPR ProcessAnalyzer KPI Card: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(TK-53703)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
KPI Card shows a single data point value with a descriptive label. Background color, shown value color and label color can be changed and set to be determined using the conditional formatting. Optionally, the data point can be visualized with an icon shown left side of the value. Also the icon type and color can be customized.
KPI Card shows a single measure value with a descriptive label. Background color, shown value color and label color can be changed and the colors can also be determined dynamically based on the measure value (using conditional formatting). Optionally, the measure can be visualized with an icon shown left side of the value. Also the icon type and color can be customized.


== KPI Card Functionalities ==
== KPI Card Functionalities ==
The KPI card has the following functionalities:
The KPI card has the following functionalities:
* KPI presents a single data point value. The measure, dimension or column used is defined by the '''KPI value''' mapping.
* KPI presents a single measure value. The measure, dimension or column used is defined by the '''KPI value''' mapping.
* Color of the icon can be set either using another measure, dimension or column mapped to the '''Color''' or with the [[#Conditional formatting|conditional formatting]] (if both are defined, the second measure is used).
* Color of the icon can be set either using another measure, dimension or column mapped to the '''Color''' or with the [[#Conditional formatting|conditional formatting]].
* Color of the shown measure value can be changed using the measure, dimension or column color (in the measure, dimension or column settings).
* Color of the shown measure value can be changed using the measure, dimension or column color (in the measure, dimension or column settings).
* The font size and text styles of the shown measure value can be changed using the measure, dimension or column settings.
* The font size and text styles of the shown measure value can be changed using the measure, dimension or column settings.
* Conditional formatting allow to determine data point value color, title color, background color and the icon color (for more information, see [[#Conditional Formatting|Conditional Formatting]]).
* Conditional formatting allow to determine data point value color, title color, background color and the icon color (for more information, see [[#Conditional Formatting|Conditional Formatting]]).
* Appearance of the shown value can be changed by using settings ''Round to decimals'', ''Measure unit'' and ''Date format'' (in the measure, dimension or column settings).
* Depending on the measure value data type, appearance of the shown value can be changed by using settings ''Decimals'', ''Unit'' and ''Date format''.
* If the visualized data point value is null or there are no rows in the dataset, the [[Measure,_Dimension_and_Column_Settings#Special_values|null value label]] is applied.
* The title of the KPI Card, the title font size, color, styling, and horizontal and vertical alignment can be changed in the ''Visual'' tab.
* The title of the KPI Card, the title font size, color, styling, and horizontal and vertical alignment can be changed in the ''Visual'' tab.
* If there are several rows in the queried dataset, a data point for each row is shown as a comma separated list.
* If there are several rows in the queried dataset, a data point for each row is shown as a comma separated list.
== Set Icon Color ==
Icon Color can be set either using another measure, dimension or column mapped to the '''Color''' or the [[#Conditional Formatting|conditional formatting]]. To use a measure, dimension or column, follow these steps:
# Select the KPI Card as a visualization.
# Define your KPI as the first measure in the '''Measures''' tab.
# In the '''Advanced settings''' of the first measure, set the '''Variable name''' field to ''measure1''.
# Select '''Data point colors''' as the second measure, and define the limit values between green-yellow and red-yellow.
Now the KPI targets are visualized as a colored icon next to the KPI value.


== Conditional Formatting==
== Conditional Formatting==
Conditional formatting is used to show the KPI Card with varying colors based on the data. The following conditional formatting are available:
Conditional formatting is used to show the KPI Card with varying colors based on the data. The following formattings are available:
* '''backgroundColor''': Background color of the KPI Card. Configured similarly than in [[QPR_ProcessAnalyzer_Table#Conditional_formatting|table conditional formatting]].
* '''backgroundColor''': Background color of the KPI Card. Configured similarly than in [[QPR_ProcessAnalyzer_Table#Conditional_formatting|table conditional formatting]].
* '''textColor''': Text color of the KPI Card. By default #0f2975 (dark blue). Configured similarly than in [[QPR_ProcessAnalyzer_Table#Conditional_formatting|table conditional formatting]].
* '''textColor''': Text color of the KPI Card. By default #0f2975 (dark blue). Configured similarly than in [[QPR_ProcessAnalyzer_Table#Conditional_formatting|table conditional formatting]].
Line 31: Line 23:
=== Conditional formatting examples ===
=== Conditional formatting examples ===


Value color:
Show a dynamic icon with a static color:
<pre>
<pre>
{
{
"textColor": {
"icon": {
"rules": [
"rules": [
{
{
"value": 100,
"comparison": ">",
"comparison": ">",
"color": "#68DD8F"
"icon": "arrow_upward"
},
},
{
{
"color": "#EF5254"
"icon": "arrow_downward"
}
}
]
],
"color": "#069cf0"
}
}
}
}
</pre>
</pre>


Title color:
Show a static icon with a dynamic color:
<pre>
<pre>
{
{
"title": {
"icon": {
"icon": "arrow_upward",
"color": {
"color": {
"scale": [
"rules": [
{
{
"value": 0,
"value": 100,
"color": "#FFFFFF"
"comparison": ">",
"color": "#68DD8F"
},
},
{
{
"value": 100,
"color": "#EF5254"
"color": "#68DD8F"
}
}
]
]
}
}
Line 70: Line 62:
</pre>
</pre>


Icon and its color:
Show a dynamic icon where the color selection is based in the 2nd measure:
<pre>
<pre>
{
{
Line 76: Line 68:
"rules": [
"rules": [
{
{
"value": { "type": "measure", "index": 2 },
"value": {
"type": "measure",
"index": 1
},
"comparison": ">",
"comparison": ">",
"icon": "arrow_upward"
"icon": "arrow_upward"
Line 85: Line 80:
],
],
"color": "#069cf0"
"color": "#069cf0"
}
}
</pre>
Define color for the shown measure value:
<pre>
{
"textColor": {
"rules": [
{
"value": 100,
"comparison": ">",
"color": "#68DD8F"
},
{
"color": "#EF5254"
}
]
}
}
</pre>
Define color for the measure title:
<pre>
{
"title": {
"color": {
"scale": [
{
"value": 0,
"color": "#FFFFFF"
},
{
"value": 100,
"color": "#68DD8F"
}
]
}
}
}
}
}

Latest revision as of 15:00, 4 April 2026

KPI Card shows a single measure value with a descriptive label. Background color, shown value color and label color can be changed and the colors can also be determined dynamically based on the measure value (using conditional formatting). Optionally, the measure can be visualized with an icon shown left side of the value. Also the icon type and color can be customized.

KPI Card Functionalities

The KPI card has the following functionalities:

  • KPI presents a single measure value. The measure, dimension or column used is defined by the KPI value mapping.
  • Color of the icon can be set either using another measure, dimension or column mapped to the Color or with the conditional formatting.
  • Color of the shown measure value can be changed using the measure, dimension or column color (in the measure, dimension or column settings).
  • The font size and text styles of the shown measure value can be changed using the measure, dimension or column settings.
  • Conditional formatting allow to determine data point value color, title color, background color and the icon color (for more information, see Conditional Formatting).
  • Depending on the measure value data type, appearance of the shown value can be changed by using settings Decimals, Unit and Date format.
  • If the visualized data point value is null or there are no rows in the dataset, the null value label is applied.
  • The title of the KPI Card, the title font size, color, styling, and horizontal and vertical alignment can be changed in the Visual tab.
  • If there are several rows in the queried dataset, a data point for each row is shown as a comma separated list.

Conditional Formatting

Conditional formatting is used to show the KPI Card with varying colors based on the data. The following formattings are available:

  • backgroundColor: Background color of the KPI Card. Configured similarly than in table conditional formatting.
  • textColor: Text color of the KPI Card. By default #0f2975 (dark blue). Configured similarly than in table conditional formatting.
  • title/color: The label color. By default #4f5765 (grey).
  • icon: Icon type that is shown left of the data point value. Configured similarly than in table conditional formatting. If only icon color is defined, the default square icon is used.
  • icon/color: Color of the icon. Configured similarly than in table conditional formatting.

Conditional formatting examples

Show a dynamic icon with a static color:

{
	"icon": {
		"rules": [
			{
				"comparison": ">",
				"icon": "arrow_upward"
			},
			{
				"icon": "arrow_downward"
			}
		],
		"color": "#069cf0"
	}
}

Show a static icon with a dynamic color:

{
	"icon": {
		"icon": "arrow_upward",
		"color": {
			"rules": [
				{
					"value": 100,
					"comparison": ">",
					"color": "#68DD8F"
				},
				{
					"color": "#EF5254"
				}
			]
		}
	}
}

Show a dynamic icon where the color selection is based in the 2nd measure:

{
	"icon": {
		"rules": [
			{
				"value": {
					"type": "measure",
					"index": 1
				},
				"comparison": ">",
				"icon": "arrow_upward"
			},
			{
				"icon": "arrow_downward"
			}
		],
		"color": "#069cf0"
	}
}

Define color for the shown measure value:

{
	"textColor": {
		"rules": [
			{
				"value": 100,
				"comparison": ">",
				"color": "#68DD8F"
			},
			{
				"color": "#EF5254"
			}
		]
	}
}

Define color for the measure title:

{
	"title": {
		"color": {
			"scale": [
				{
					"value": 0,
					"color": "#FFFFFF"
				},
				{
					"value": 100,
					"color": "#68DD8F"
				}
				
			]
		}
	}
}