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

BaseMetricType

BaseMetricType is an abstract complex type used to hold the attribute and element definitions that are common across counters, stopwatches, and metrics.

Elements

None

Attributes

Name Required or optional Type Description
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.

id Required String The unique identifier of the metric, counter, or stopwatch.
isSortable Optional Boolean Whether the metric, counter, or stopwatch can be used for sorting. The default value is false. isSortable gives a hint to the implementation of this model, not a requirement to create an index or perform a query.
type Required QName The data type of the metric. The available types are a subset of the data types defined by the XML schema. The following types are available:

  • xsd:string
  • xsd:boolean
  • xsd:decimal
  • xsd:integer
  • xsd:dateTime
  • xsd:date
  • xsd:time
  • xsd:duration

hideFromDashboards Optional Boolean Whether to prevent the metric, counter, or stopwatch from being displayed on the dashboard. The default is false.

Restrictions

See CounterType, StopwatchType, and MetricType.

Schema definition

<xsd:complexType name="BaseMetricType" abstract="true">
    <xsd:complexContent>
        <xsd:extension base="mon:NamedElementType">
            <xsd:attribute name="type" type="xsd:QName"
                 use="required"/>
            <xsd:attribute name="isSortable" 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