MonitoringContextType

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
MonitoringContextType

MonitoringContextType represents the events and data that are being monitored.
Elements

Name Min-max Description
inboundEvent 0 - n The events that this context has an interest in.
outboundEvent 0 - n The events that this context might generate.
counter 0 - n The counters within the monitoring context. Counters are incremented, decremented, or reset upon the firing of specified triggers.
metric 0 - n The metrics within the monitoring context. Metrics contain maps that define the way that the metric is updated.
stopwatch 0 - n The stopwatches within the monitoring context. Stopwatches are started, stopped, and reset upon the firing of specified triggers.
trigger 0 - n The triggers that the monitoring context generates.
description 0 - 1 (Optional) A description of the monitoring context.
monitoringContext 0 - n The child monitoring contexts inside the monitoring context.

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 for the monitoringContext.
hideFromDashboards Optional Boolean An indicator that specifies whether to prevent the monitoring context from being displayed on the dashboard. The default is false.

Restrictions

Each monitoringContext must have at least one metric with isPartOfKey set to true.

Schema definition
<xsd:complexType name="MonitoringContextType" >
    <xsd:complexContent>
        <xsd:extension base="mon:ContextType">
               <xsd:choice minOccurs="0" maxOccurs="unbounded">
                   <xsd:element name="metric" type="mon:MetricType"/>
                   <xsd:element name="counter" type="mon:CounterType"/>
                   <xsd:element name="stopwatch" type="mon:StopwatchType"/>
                   <xsd:element name="monitoringContext" type="mon:MonitoringContextType"/>
               </xsd:choice>
               <xsd:attribute name="hideFromDashboards" type="xsd:boolean" use="optional" default="false" />
        </xsd:extension>
    </xsd:complexContent>
</xsd:complexType>
XML schema (monitor.xsd) description

Name	Min-max	Description
inboundEvent	0 - n	The events that this context has an interest in.
outboundEvent	0 - n	The events that this context might generate.
counter	0 - n	The counters within the monitoring context. Counters are incremented, decremented, or reset upon the firing of specified triggers.
metric	0 - n	The metrics within the monitoring context. Metrics contain maps that define the way that the metric is updated.
stopwatch	0 - n	The stopwatches within the monitoring context. Stopwatches are started, stopped, and reset upon the firing of specified triggers.
trigger	0 - n	The triggers that the monitoring context generates.
description	0 - 1	(Optional) A description of the monitoring context.
monitoringContext	0 - n	The child monitoring contexts inside the monitoring context.

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 for the monitoringContext.
hideFromDashboards	Optional	Boolean	An indicator that specifies whether to prevent the monitoring context from being displayed on the dashboard. The default is false.