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

MonitorType

MonitorType is the type of the root document element. It contains the various models that are required to perform monitoring activities.

Elements

Name	Min-max	Description
xpathFunctions	0 - 1	The container for any functions added by the user.
monitorDetailsModel	1 - 1	The container for monitoring contexts, metrics, triggers, and so on.
dimensionalModel	0 - 1	The container for the cubes, measures, and dimensions.
kpiModel	0 - 1	The container for the key performance indicator (KPI) definitions.
visualModel	0 - 1	The container for the visual elements used in the dashboards to graphically display the monitored process.
eventModel	1 - 1	The container for the events that this monitor is interested in and a sequence of import statements that identify the external files that contain the event definitions.
description	0 - 1	(Optional) A description of the monitor model.

Attributes

Name	Required or optional	Type	Description
targetNamespace	Optional	Any URI	The target namespace for this monitor.
timestamp	Required	DateTime	The version of the monitor model. You must set this attribute.
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 monitor.

Restrictions

• The complete set of documents referred to in the XML document (that is, Common Base Event, XML, WSDL, and SVG file imports) must be available to the Business Monitor server at deployment time .
• MonitorType must have a valid timestamp.

Schema definition

<xsd:complexType name="MonitorType" >
    <xsd:complexContent>
        <xsd:extension base="mon:NamedElementType">
            <xsd:sequence>
                <xsd:element name="xpathFunctions" 
                      type="mon:XPathFunctionsType" minOccurs="0" 
                      maxOccurs="1"/>
                <xsd:element name="monitorDetailsModel" 
                      type="mon:MonitorDetailsModelType" minOccurs="1" 
                      maxOccurs="1"/>    
                <xsd:element name="kpiModel" type="mon:KPIModelType" 
                      minOccurs="0" maxOccurs="1"/>    
                <xsd:element name="dimensionalModel" 
                     type="mon:DimensionalModelType" minOccurs="0" 
                     maxOccurs="1"/>
                <xsd:element name="visualModel" type="mon:VisualModelType" 
                      minOccurs="0" maxOccurs="1"/>
                <xsd:element name="eventModel" type="mon:EventModelType" 
                      minOccurs="1" maxOccurs="1"/>
            </xsd:sequence>
            <xsd:attribute name="targetNamespace" type="xsd:anyURI" 
                  use="optional"/>
            <xsd:attribute name="timestamp" type="xsd:dateTime" 
                  use="required"/>
        </xsd:extension>
    </xsd:complexContent>
</xsd:complexType>

XML schema (monitor.xsd) description