IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing monitor models > What are monitor models? > Monitor XML schema definition (monitor.xsd) > XML schema (monitor.xsd) description

KPIType

KPIType holds the key performance indicator (KPI) data for the KPI, such as targets and thresholds, as well as the definition that describes how the KPI is calculated using either an aggregated metric or a calculation using other KPIs. KPIType is used in KPIContextType.

Elements

Name	Min-max	Description
aggregatedDefinition	1 - 1	The definition of a KPI based on aggregating a metric, with optional time and data filters.
calculatedDefinition	1 - 1	The definition of a KPI based on a calculation using other KPIs.
description	0 - 1	A user-provided description.
target	0 - 1	The default target value.
range	0 - n	The ranges for this KPI.

Attributes

Name	Required or optional	Type	Description
type	Required	QName	The type of the KPI, which is the same as the type of the underlying metric.
rangeType	Required	RangeTypeType	Whether the range values are actual values or percentages.
enableKpiHistory	Optional	boolean	Whether to preserve the historical values of KPIs for viewing and analysis. The default value is true.
currency	Optional	KPICurrencyType	The type of currency to use when formatting the KPI as a currency value. If you choose this option, you cannot also choose decimalPrecision or showPercent.
decimalPrecision	Optional	nonNegativeInteger	The number of decimal places to include in the KPI value. The default number of decimal places is 0.
showPercent	Optional	boolean	Whether to format the KPI value as a percentage. If this option is selected, the value will be multiplied by 100 and a percent sign (%) will be added. For example, 0.3 becomes 30%. The default value is false.
hideFromDashboards	Optional	boolean	Whether to prevent the KPI from being displayed on the dashboard. The default is false.

Restrictions

• If rangeType = "percentage", then kpi/target must exist and have a value.

Schema definition

<xsd:complexType name="KPIType" >
  <xsd:complexContent>
    <xsd:extension base="mon:NamedElementType">
      <xsd:sequence>
        <xsd:choice minOccurs="1" maxOccurs="1">
          <xsd:element name="aggregatedDefinition" 
                       type="mon:KPIAggregatedDefinitionType"/>
          <xsd:element name="calculatedDefinition" 
                       type="mon:KPICalculatedDefinitionType"/>
        </xsd:choice>
        <xsd:element name="target" type="mon:TargetValueType" 
                     minOccurs="0" maxOccurs="1" />					
        <xsd:element name="range" type="mon:RangeType"
                     minOccurs="0" maxOccurs="unbounded"/>
      </xsd:sequence>
      <xsd:attribute name="type" type="xsd:QName" use="required"/>				
      <xsd:attribute name="rangeType" type="mon:RangeTypeType" 
                     use="required"/>
      <xsd:attribute name="enableKpiHistory" type="xsd:boolean" 
                     default="true"/>
      <xsd:attribute name="currency" type="mon:KPICurrencyType" 
                     use="optional"/>
      <xsd:attribute name="decimalPrecision" type="xsd:nonNegativeInteger" 
                     default="0"/>
      <xsd:attribute name="showPercent type="xsd:boolean" default="false"/>
      <xsd:attribute name="hideFromDashboards" type="xsd:boolean"
	             use="optional" default="false"/>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>

XML schema (monitor.xsd) description