onTimeOut element

The <onTimeOut> element is valid only for the sequence and threshold rules. It specifies the action or set of actions to take if the time window for the rule expires.

Details

Table 1 describes how the time window expires for each rule type where an <onTimeOut> action is valid.
Table 1. How the time window expires based on the rule type
Rule type How the time window expires
sequence The time window expires if one or more events are accepted but the full sequence of events is not received within the time window.
threshold The time window expires if one or more events are accepted but the threshold is not met within the time window.
If the rule set contains multiple rules that are activated at the same date and time, or by the same event, and that have the same time window, the following actions for these rules do not run at exactly the same time:
  • Rule response actions within the <onTimeOut> and <onTimeWindowComplete> elements
  • Life cycle actions within the <onActivation> and <onDeactivation> elements
These actions run sequentially in any order. They do not necessarily run in the order in which they are coded in the rule set. Because each action must be completed before the next action in the sequence begins, the actions do not run at the same time.

Attributes

<onTimeOut> has no attributes.

Contained within

<onTimeOut> is contained within the following elements:

Contains

<onTimeOut> contains the following element:

Table 2. Elements contained within the <onTimeOut> element
Element Required or optional?
<action> Optional. 0 or more occurrences are allowed.