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

MetricType

MetricType describes a metric in a monitoringContext.

Elements

Name	Min-max	Description
defaultValue	0 - 1	The value specification expression that defines the initial value for the metric.
mapDefinition	0 - n	The way that the metric is assigned its value.
description	0 - 1	A user-provided description of the metric.

Attributes

Name	Required or optional	Type	Description
isPartOfKey	Optional	Boolean	Whether the metric is part of the key for the monitoring context. The default value is false.
valueRequired	Optional	Boolean	Whether the default value for this metric is required. A default value is required if the metric is to be used as a dimension level. The default is false.
maxStringLength	Optional	Integer	The maximum length of a String metric. The default value is 256. maxStringLength is used only for metrics of type String and is ignored in all other cases.
isMultiByte	Optional	Boolean	Whether the metric might contain international strings. The default value is false. isMultiByte is used only for metrics of type String and is ignored in all other cases.
isSortable	Optional	Boolean	Whether the metric can be used for sorting. The default value is false.
displayName	Optional	String	The name to display in the Monitor Model editor and Business Monitor dashboards. If a displayName is not provided, the ID attribute is used.
type	Required	QName	The type of the metric. The following subsets of xsd are available: xsd:integer, xsd:decimal, xsd:string,:xsd:boolean, xsd:duration, xsd:dateTime, xsd:date, and xsd:time. Extra precision for numeric values is not supported.
id	Required	String	The unique identifier among all elements in the same monitoring context.

Restrictions

• A metric must be one of String, Boolean, Decimal, Integer, Date, Time, DateTime, Duration.

• The DefaultValue cannot contain assignments.

• The initial context of the DefaultValue expression is the containing context.
• DefaultValue expression scope: No references allowed.

• The DefaultValue expression must be a literal (contain no references) if the metric is a key.

• The DefaultValue expression's type must match the metric's type.

• There must be at least one singleValue in the metric, either in a map or in the defaultValue.

Schema definition

<xsd:complexType name="MetricType" >
    <xsd:complexContent>
        <xsd:extension base="mon:BaseMetricType">
            <xsd:sequence>
                <xsd:element name="map" type="mon:MapType" minOccurs="0" 
                      maxOccurs="unbounded"/>                
                <xsd:element name="defaultValue" 
                      type="mon:ValueSpecificationType" minOccurs="0" 
                      maxOccurs="1"/>
            </xsd:sequence>
            <xsd:attribute name="isPartOfKey" type="xsd:boolean" 
                  default="false"/>
            <xsd:attribute name="valueRequired" type="xsd:boolean" 
                  default="false"/>
            <xsd:attribute name="maxStringLength" type="xsd:integer" 
                  default="256"/>
            <xsd:attribute name="isMultiByte" type="xsd:boolean" 
                  default="false"/>
        </xsd:extension>
    </xsd:complexContent>
</xsd:complexType>

XML schema (monitor.xsd) description