KPIAggregatedDefinitionType

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
KPIAggregatedDefinitionType

KPIAggregatedDefinitionType holds the definition of a KPI that is based on an aggregated metric. It includes the metric, aggregation function, time filter, and data filter. KPIAggregatedDefinitionType is used in KPIType.
Elements

Name Min-max Description
monitoringContext 1 - 1 The monitoring context that contains the metric on which the value of the KPI is based.
metric 1 - 1 The metric on which the value of the KPI is based.
metricFilter 0 - n Expressions that describe how to filter the KPI based on other metrics.
dateTimeMetricFilter 0 - 1 The time period type to use when calculating the KPI value.

Attributes

Name Required or optional Type Description
aggregationType Required AggregationType One of the valid aggregation types defined in AggregationType.
versionAggregation Optional VersionAggregationType Whether to based the KPI on all versions of the model, or only the most recent version of the model. The default is all versions.

Restrictions

None

Schema definition
<xsd:complexType name="KPIAggregatedDefinitionType">
  <xsd:sequence>
    <xsd:element name="monitoringContext" type="mon:ReferenceType" 
                 minOccurs="1" maxOccurs="1"/>
    <xsd:element name="metric" type="mon:ReferenceType" 
                 minOccurs="1" maxOccurs="1"/>
    <xsd:element name="metricFilter" type="mon:KPIMetricFilterRefType" 
                 minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element name="dateTimeMetricFilter" 
                 type="mon:KPIDateTimeMetricFilterRefType" 
                 minOccurs="0" maxOccurs="1"/>
  </xsd:sequence>
  <xsd:attribute name="aggregationType" type="mon:AggregationType" 
                 use="required"/>
  <xsd:attribute name="versionAggregation" 
                 type="mon:VersionAggregationType" default="allVersions"/>
</xsd:complexType>	
XML schema (monitor.xsd) description

Name	Min-max	Description
monitoringContext	1 - 1	The monitoring context that contains the metric on which the value of the KPI is based.
metric	1 - 1	The metric on which the value of the KPI is based.
metricFilter	0 - n	Expressions that describe how to filter the KPI based on other metrics.
dateTimeMetricFilter	0 - 1	The time period type to use when calculating the KPI value.

Name	Required or optional	Type	Description
aggregationType	Required	AggregationType	One of the valid aggregation types defined in AggregationType.
versionAggregation	Optional	VersionAggregationType	Whether to based the KPI on all versions of the model, or only the most recent version of the model. The default is all versions.