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

OutboundEventType

OutbountEventType describes an event that is emitted from a monitoring context. Outbound events are generated when triggers that are specified in the map of the outbound event fire. If triggers are identified in multiple maps in the outbound event, multiple outbound events will be generated. If the same trigger is identified in multiple maps, multiple outbound events will fire. One outbound event will fire for each map that is run (provided the outbound event filter evaluates to true). If a map for an outbound event has no trigger, it will never run, even if the elements it refers to are updated.

Elements

Name	Min-max	Description
eventPart	0 - n	Parts of the event. Each eventPart specifies the structure of the content that will fill that slot at run time.
map	1 - n	The way that the values in the outbound event are set.
filter	0 - 1	An expression that must evaluate to true before the outbound event is emitted. This filter expression is evaluated after the map assigns the values to the outbound event attributes.
description	0 - 1	A user-provided description for the outbound event.

Attributes

Name	Required or optional	Type	Description
displayName	Optional	String	The name to display in the Monitor Model editor and Business Monitor dashboards. If the attribute is not set, the ID attribute will be used for the display name.
id	Required	String	The unique identifier for the outbound event. The ID of the outbound event must be unique for each outbound event in the containing monitoringContext.
rootElement	Required	QName	The fixed value "cbe:CommonBaseEvent".
extensionName	Optional	String	The name of a Common Base Event file.
type	Required	Pointer to the event type	An existing eventType.

Restrictions

• The outboundEvent event type must exist.
• (Warning) The outboundEvent event type must have at least one map with a trigger, or it will never fire.

• The filter expression must evaluate to an effective Boolean value.

• The filter expression initial context is the current context.
• Filter expression scope:
  • Properties and extendedDataElements of this outboundEvent
  • BaseMetrics that provably exist
  • Properties and extendedDataElements of an inboundEvent if the inboundEvent is the only way for the outboundEvent to fire
  • KPI values, targets, and ranges if this outboundEvent is in a KPI context

Schema definition

<xsd:complexType name="OutboundEventType" >
  <xsd:complexContent>
    <xsd:extension base="mon:NamedElementType">
       <xsd:sequence>
       	 <xsd:element name="eventPart" type="mon:EventPartType" 
                      minOccurs="0" maxOccurs="unbounded" />
         <xsd:element name="map" type="mon:MapType" minOccurs="1" 
                     maxOccurs="unbounded"/>
         <xsd:element name="filter" type="mon:ExpressionSpecificationType" 
                     minOccurs="0" maxOccurs="1"/>
       </xsd:sequence>
       <xsd:attribute name="rootElement" type="xsd:QName" use="required" />    
       <xsd:attribute name="extensionName" type="xsd:string" use="optional" />
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>    

XML schema (monitor.xsd) description