QPR ProcessAnalyzer KPI Card

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search

KPI Card shows a single data point value with a descriptive label. Background color, data point text color and label color can be changed and set to be conditionally determined. 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 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.
  • Color of the icon can be set either using another measure, dimension or column mapped to the Color or with the conditional formatting (if both are defined, the second measure is used).
  • Color of the shown measure value can be changed using the measure, dimension or column color (in 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).
  • 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).
  • Title of the measure can be changed by using the title field in the General tab.
  • 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 Using Second Measure

Icon Color can be set either using a measure, dimension or column mapped to the Color or the conditional formatting. To use a measure, dimension or column, follow these steps:

  1. Select the KPI Card as a visualization.
  2. Define your KPI as the first measure.
  3. In the Advanced settings of the first measure, set text measure1 to the Variable name field.
  4. 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

The following conditional formatting 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: Settings related to the measure title (label). Currently, only the title color can be changed.
    • color: Color of the measure title (label). By default #4f5765 (grey).
  • icon: Icon type that is shown left of the measure value. Configured similarly than in table conditional formatting. If only icon color is defined, the default square icon is used.

Conditional Formatting Examples

Measure value color:

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

Title color:

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

Icon and its color:

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