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

TriggerType

TriggerType describes a trigger in a monitoringContext.

Elements

Name	Min-max	Description
onTrigger	1 - n	A reference to a trigger name. The trigger name must exist in the monitoringContext.
evaluationTime	1 - n	A TimeInterval that indicates the duration of time between evaluations. If a time interval is missed, the trigger will fire on the next occurrence of the time interval.
onValueChange	1 - n	A reference to a metric, counter, or timer in the monitoringContext. The metric, counter, or timer must exist in the monitoringContext.
onEvent	1 - n	A reference to an inboundEvent. The name of the event must match an event in the monitoringContext.
gatingConditon	0 - 1	A condition that is evaluated before the firing of the trigger. If the gating condition evaluates to true, the trigger will fire; otherwise, it will not.
evaluateAtDateTime	1 - n	The specific time at which an evaluation occurs (for example, the current time plus three hours).
evaluateAtTimeEachDay	1 - n	The specific time each day at which an evaluation occurs (for example, 3:00 p.m. daily).
description	0 - 1	A user-provided description of the trigger.

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.
isRepeatable	Optional	Boolean	If isRepeatable is set to true, the trigger will fire each time the gating condition evaluates to true. If isRepeatable is set to false, only the first in a series of true evaluations of the gating condition will cause the trigger to fire, and the trigger will only fire again after the gating condition evaluates to false at least once. The default value is false.
id	Required	String	The unique identifier for the trigger. The ID must be unique, as specified in ID uniqueness constraints.
terminateContext	Optional	Boolean	Whether to terminate the containing context when the trigger fires. The default value is false.

Restrictions

• Triggers in KPI contexts cannot terminate a context.
• Triggers cannot contain any circular references in the trigger chain.
• GatingCondition must evaluate to an effective Boolean value.

• The initial context for gatingCondition is the current context.

• The gatingCondition expression scope is as follows:
  • BaseMetrics that provably exist.
  • Properties and extendedDataElements of an inboundEvent if the inboundEvent is the only way for the trigger to fire.
  • KPI values, targets, and ranges if the trigger is in a KPI context.

• The onTrigger reference is a valid reference.

• The onTrigger referenced object is of type TriggerType.

• The onTrigger referenced object is in the same context as the trigger or in a child context of the context containing the trigger.

• The onValueChange reference is a valid reference.

• The onValueChange referenced object is derived from BaseMetricType.

• The onValueChange referenced object is in the same context as the trigger or in a child context of the context containing the trigger.

• The onEvent reference is a valid reference.

• The onEvent referenced object is of type InboundEventType.

• The onEvent referenced object is in the same context as the trigger, or in a child context of the context containing the trigger.

Schema definition

<xsd:complexType name="TriggerType" >
    <xsd:complexContent>
        <xsd:extension base="mon:NamedElementType">
            <xsd:sequence>                
                <xsd:choice minOccurs="1" maxOccurs="unbounded">
                    <xsd:element name="onTrigger" type="mon:ReferenceType"/>
                    <xsd:element name="evaluationTime" 
                          type="mon:TimeIntervalsType"/>
                    <xsd:element name="onValueChange" 
                          type="mon:ReferenceType"/>
                    <xsd:element name="onEvent" type="mon:ReferenceType" />
                    <xsd:element name="evaluateAtDateTime" 
                          type="mon:ExpressionSpecificationType" />
                    <xsd:element name="evaluateAtTimeEachDay"
                          type="mon:ValueSpecificationType" />
                </xsd:choice>
                <xsd:element name="gatingCondition" 
                      type="mon:ExpressionSpecificationType" minOccurs="0" 
                      maxOccurs="1"/>
            </xsd:sequence>
            <xsd:attribute name="isRepeatable" type="xsd:boolean" 
                  default="false"/>
            <xsd:attribute name="terminateContext" type="xsd:boolean" 
                  default="false"/>
        </xsd:extension>
    </xsd:complexContent>
</xsd:complexType>

XML schema (monitor.xsd) description