KPI export schema definition (kpi.xsd)
The key performance indicator (KPI) definitions that are exported from the server or imported to the server at run time are in an XML format that is defined by the kpi.xsd schema. This schema extends the monitor.xsd schema.
The complete schema is provided on this page.
<xsd:schema
xmlns:kpi="http://www.ibm.com/xmlns/prod/websphere/monitoring/6.1.0/kpi"
xmlns:mm="http://www.ibm.com/xmlns/prod/websphere/monitoring/8.5/mm"
xmlns:xmi="http://www.omg.org/XMI" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.ibm.com/xmlns/prod/websphere/monitoring/6.1.0/kpi">
<xsd:import namespace="http://www.ibm.com/xmlns/prod/websphere/monitoring/8.5/mm" schemaLocation="monitor.xsd"></xsd:import>
<xsd:element name="kpis" type="kpi:KPIListType" />
<xsd:complexType name="KPIListType">
<xsd:sequence>
<xsd:element name="kpi" type="kpi:KPIDefinitionType"
maxOccurs="unbounded" minOccurs="0">
</xsd:element>
</xsd:sequence>
<xsd:attribute name="modelId" type="xsd:NCName" use="required"></xsd:attribute>
<xsd:attribute name="version" type="xsd:long" use="required"></xsd:attribute>
<xsd:attribute name="kpiContextId" type="xsd:NCName" use="required"></xsd:attribute>
</xsd:complexType>
<xsd:complexType name="KPIDefinitionType">
<xsd:complexContent>
<xsd:extension base="mm:NamedElementType">
<xsd:sequence>
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="aggregatedDefinition" type="mm:KPIAggregatedDefinitionType"/>
<xsd:element name="calculatedDefinition" type="mm:KPICalculatedDefinitionType"/>
</xsd:choice>
<xsd:element name="history" type="kpi:historyTimeRangeMethodType" minOccurs="0" maxOccurs="1" />
<xsd:element name="target" type="mm:TargetValueType" minOccurs="0" maxOccurs="1" />
<xsd:element name="range" type="kpi:KPIRangeType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="predictionModel" type="kpi:KPIPredictionModelDefinitionType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="type" type="xsd:QName" use="required"/>
<xsd:attribute name="rangeType" type="mm:RangeTypeType" use="required"/>
<xsd:attribute name="origin" type="kpi:KPIOriginType" default="modeled"/>
<xsd:attribute name="viewAccess" type="kpi:KPIViewAccessType" default="public"/>
<xsd:attribute name="userId" type="xsd:string" default=""/>
<xsd:attribute name="enableKpiHistory" type="xsd:boolean" default="true"/>
<xsd:attribute name="enableKpiPrediction" type="xsd:boolean" default="true"/>
<xsd:attribute name="currency" type="kpi:KPICurrencyType"/>
<xsd:attribute name="decimalPrecision" type="xsd:nonNegativeInteger" default="0"/>
<xsd:attribute name="showPercent" type="xsd:boolean" default="false"/>
<xsd:attribute name="kpiCacheOverrideInterval" type="xsd:nonNegativeInteger" default="0"/>
<xsd:attribute name="defaultPredictionModelId" type="xsd:string" default=""/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="KPIPredictionModelDefinitionType">
<xsd:attribute name="id" type="xsd:NCName" use="required"/>
<xsd:attribute name="displayName" type="xsd:string" default=""/>
<xsd:attribute name="intervalsPerCycle" type="xsd:nonNegativeInteger" default="0"/>
<xsd:attribute name="predictionHorizon" type="xsd:nonNegativeInteger" default="0"/>
<xsd:attribute name="predictToPeriodEnd" type="xsd:boolean" default="false"/>
<xsd:attribute name="predictionIntervalUnit" type="kpi:PredictionIntervalUnitType"/>
<xsd:attribute name="predictionSubModelId" type="xsd:NCName"/>
</xsd:complexType>
<xsd:simpleType name="PredictionIntervalUnitType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="hourly"/>
<xsd:enumeration value="daily"/>
<xsd:enumeration value="weekly"/>
<xsd:enumeration value="monthly"/>
<xsd:enumeration value="quarterly"/>
<xsd:enumeration value="yearly"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="historyTimeRangeMethodType">
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="repeatingPeriod" type="kpi:historyRepeatingPeriodType"/>
<xsd:element name="rollingPeriod" type="kpi:historyRollingPeriodType"/>
<xsd:element name="fixedPeriod" type="kpi:historyFixedPeriodType"/>
</xsd:choice>
<xsd:attribute name="historyGranularity" type="kpi:HistoryGranularityType"/>
<xsd:attribute name="historyAllVersions" type="xsd:boolean" default="false"/>
<xsd:attribute name="historyTimezone" type="xsd:string" use="optional"/>
<xsd:attribute name="historyDisplayTarget" type="xsd:boolean" default="false"/>
<xsd:attribute name="historyDisplayRanges" type="xsd:boolean" default="false"/>
<xsd:attribute name="historyRetroActiveCalculationQuantity" type="xsd:nonNegativeInteger" default="0"/>
</xsd:complexType>
<xsd:complexType name="historyRepeatingPeriodType">
<xsd:attribute name="historyRepeatingPeriodBasis" type="mm:PeriodBasisType"/>
<xsd:attribute name="historyRepeatingPeriodDuration" type="kpi:HistoryRepeatingPeriodTypeType"/>
<xsd:attribute name="historyRepeatingPeriodQuantity" type="xsd:nonNegativeInteger" default="0"/>
</xsd:complexType>
<xsd:complexType name="historyRollingPeriodType">
<xsd:attribute name="historyRollingPeriodDuration" type="kpi:HistoryRollingPeriodTypeType"/>
<xsd:attribute name="historyRollingPeriodQuantity" type="xsd:nonNegativeInteger" default="0"/>
</xsd:complexType>
<xsd:complexType name="historyFixedPeriodType">
<xsd:attribute name="historyTimeRangeStart" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="historyTimeRangeEnd" type="xsd:dateTime" use="optional"/>
</xsd:complexType>
<xsd:simpleType name="HistoryGranularityType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="hourly"/>
<xsd:enumeration value="daily"/>
<xsd:enumeration value="weekly"/>
<xsd:enumeration value="monthly"/>
<xsd:enumeration value="quarterly"/>
<xsd:enumeration value="yearly"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="HistoryRepeatingPeriodTypeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="daily"/>
<xsd:enumeration value="weekly"/>
<xsd:enumeration value="monthly"/>
<xsd:enumeration value="quarterly"/>
<xsd:enumeration value="yearly"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="HistoryRollingPeriodTypeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="hours"/>
<xsd:enumeration value="days"/>
<xsd:enumeration value="weeks"/>
<xsd:enumeration value="months"/>
<xsd:enumeration value="quarters"/>
<xsd:enumeration value="years"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="KPIRangeType">
<xsd:complexContent>
<xsd:extension base="mm:RangeType">
<xsd:attribute name="icon" type="xsd:string" default=""/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:simpleType name="KPIOriginType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="modeled"/>
<xsd:enumeration value="runtime"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="KPIViewAccessType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="public"/>
<xsd:enumeration value="personal"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="KPIRangeColorType">
<xsd:restriction base="xsd:string">
<xsd:length value="6"/>
<xsd:pattern value="[0-9a-fA-F]{6}"></xsd:pattern>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="KPICurrencyType">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[A-Z]{3}"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>