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

InboundEventType

InboundEventType identities the inbound events in which this monitoringContext is interested.

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.
correlationPredicate	0 - 1	The specific monitoringContext definition instances to which the event should be delivered.
filter	0 - 1	The filter conditions for the event.
description	0 - 1	A user-provided description of the inbound 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 a displayName is not provided, the ID attribute is used.
id	Required	String	The identifier for this inbound event. The ID must be unique according to ID uniqueness constraints.
rootElement	Required	QName	The fixed value "cbe:CommonBaseEvent".
extensionName	Optional	String	The name of a Common Base Event file.
eventSequenceIDPath	Optional	String	The path to an event attribute that indicates a sequencing order for inbound events. This value overrides any path expression specified at the context level. The default is the path to the creationTime attribute.
creationTimePath	Optional	String	The path to an event attribute that indicates the creation time of the event. This value overrides any path expression specified at the context level. The default is the path to the Common Base Event creationTime attribute, which contains the time at which the event is created, in UTC.
globalInstanceIDPath	Optional	String	The path to an event attribute that indicates the global instance ID. This value overrides any path expression specified at the context level. The default is the path to the Common Base Event globalInstanceId, which is an automatically generated identifier to uniquely identify the event.
noCorrelationMatches	Optional	EventDeliveryOptionNoMatchesType	One of the values ignore, raiseException, createNewContext, or retry. The retry value is deprecated when no instances are found for an inbound event. You should consider selecting another value, such as the raiseException option.
oneCorrelationMatch	Optional	EventDeliveryOptionOneMatchType	One of the values ignore, raiseException, or deliverEvent.
multipleCorrelationMatches	Optional	EventDeliveryOptionMultipleMatchesType	One of the values raiseException, deliverToAny, or deliverToAll.
terminateContext	Optional	Boolean	Whether to terminate the containing context when the trigger fires. The default value is false.

Restrictions

• The inboundEvent event type must exist.

• In a monitoringContext, noCorrelationMatches, oneCorrelationMatch, and multipleCorrelationMatches attributes must be present.

• In a kpiContext, noCorrelationMatches, oneCorrelationMatch, and multipleCorrelationMatches attributes must not be present.

• To create an event, all keyMetrics must have a defaultValue or one map that (implicitly) triggers only from this inboundEvent.

• The correlationPredicate expression must be valid.

• The correlationPredicate expression scope is the properties and extendedDataElements of the inboundEvent and baseMetrics in the current context or an ancestor context.

• The correlationPredicate expression initial context is the current context.

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

• To create an event, the correlationPredicate must exist and must refer to all keyMetrics of the parent context of the current context.

• The filter expression must be valid.

• The filter expression scope is the properties and extendedDataElements in this inboundEvent.

• The filter expression initial context is the current context.

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

Schema definition

<xsd:complexType name="InboundEventType" >
  <xsd:complexContent>
    <xsd:extension base="mon:NamedElementType">
      <xsd:sequence>
        <xsd:element name="eventPart" type="mon:EventPartType" 
                     minOccurs="0" maxOccurs="unbounded" />
        <xsd:element name="correlationPredicate" 
                     type="mon:ExpressionSpecificationType" 
                     minOccurs="0" maxOccurs="1" />
        <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:attribute name="eventSequenceIDPath" type="xsd:string" 
                     use="optional"/>
      <xsd:attribute name="creationTimePath" type="xsd:string" 
                     use="optional"/>
      <xsd:attribute name="globalInstanceIDPath" type="xsd:string" 
                     use="optional"/>                
      <xsd:attribute name="noCorrelationMatches" 
                     type="mon:EventDeliveryOptionNoMatchesType"
                     use="optional"/>
      <xsd:attribute name="oneCorrelationMatch" 
                     type="mon:EventDeliveryOptionOneMatchType"
                     use="optional"/>
      <xsd:attribute name="multipleCorrelationMatches"
                     type="mon:EventDeliveryOptionMultipleMatchesType"
                     use="optional"/>
      <xsd:attribute name="terminateContext" type="xsd:boolean" 
                     default="false"/>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>

XML schema (monitor.xsd) description