QPR ProcessAnalyzer KPI Card

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

KPI Card shows a single measure value. In addition to the value, the measure label is shown. Measure value color, title color and background color can be changed. Optionally, the measure can be visualized with an icon shown left side of the measure. The icon type and color can be customized.

KPI Card Functionalities

The KPI card has the following functionalities:

  • KPI is able present a single measure value (which is set in the first measure).
  • Color of the icon can be set either using the second measure 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 color (in the measure's Advanced Settings).
  • Conditional formatting allow to determine measure value color, title color, background color and the icon color (for more information, see Conditional Formatting).
  • Appearance of the shown value can be changed in the first measure settings, using settings Round to decimals, Measure unit, Data type and Date format.
  • Title of the measure can be changed either by specifying a custom measure label in the measure advanced settings or use the title field in the General tab.
  • It's possible to define a dimension, which will show measure values for all those dimension values as a list.

Set Icon Color Using Second Measure

Icon Color can be set either using the seconds measure or the conditional formatting. To use the second measure, 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:

  • 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.
  • textColor: Text color of the KPI Card. By default #0f2975 (dark blue). Configured similarly than in table conditional formatting.
  • backgroundColor: Background color of the KPI Card. 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).

It's also possible to define a dimension for the KPI Card, which shows a list of measure values for each dimension.

Conditional Formatting Examples

Measure text 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"
	}
}