runUntilDeactivated element

The <runUntilDeactivated> element specifies that the time window continues to be open until the rule is deactivated. Therefore, the time window for this rule starts when the rule begins processing, and it does not stop until the rule is deactivated or removed from the rule set, or the Active Correlation Technology engine shuts down.

Details

The specific behavior of a rule that includes the <runUntilDeactivated> element is dependent on the rule type. Table 1 describes the rule behavior for each rule type where the <timeWindow> element is valid and contains the <runUntilDeactivated> element.
Table 1. Rule behavior when <runUntilDeactivated> is coded
Rule type Rule behavior when <runUntilDeactivated> is coded
collection The collection rule accepts the first event that meets its event selection criteria, and it continues to accept and process events until the rule is deactivated, at which time the actions that are defined within the <onTimeWindowComplete> element are run, immediately followed by the actions that are defined within the <onDeactivation> element.
computation The computation rule accepts the first event that meets its event selection criteria, and it continues to accept and process events until the rule is deactivated, at which time the actions that are defined within the <onTimeWindowComplete> element are run, immediately followed by the actions that are defined within the <onDeactivation> element.
duplicate The duplicate rule accepts the first event that meets its event selection criteria, and it continues to accept and process events until the rule is deactivated, at which time the actions that are defined within the <onTimeWindowComplete> element are run, immediately followed by the actions that are defined within the <onDeactivation> element.
sequence The sequence rule accepts the first event that meets its event selection criteria, and it continues to accept and process events until either of the following circumstances occurs:
  • The sequence pattern is detected. When this occurs, the actions that are defined within the <onDetection> element are run, and the rule returns to its initial state. Event processing by this rule begins again, and this process can repeat many times until the rule is deactivated.
  • The rule is deactivated while it is processing events. When this occurs, the actions that are defined within the <onTimeOut> element are run, immediately followed by the actions that are defined within the <onDeactivation> element.
threshold The threshold rule accepts the first event that meets its event selection criteria, and it continues to accept and process events until either of the following circumstances occurs:
  • The threshold pattern is detected. When this occurs, the actions that are defined within the <onDetection> element are run, and the rule returns to its initial state. Event processing by this rule begins again, and this process can repeat many times until the rule is deactivated.
  • The rule is deactivated while it is processing events. When this occurs, the actions that are defined within the <onTimeOut> element are run, immediately followed by the actions that are defined within the <onDeactivation> element.
timer After the timer rule becomes active, it does nothing until it is deactivated, at which time the actions that are defined within the <onTimeWindowComplete> element are run, immediately followed by the actions that are defined within the <onDeactivation> element. The repeat attribute on the <timerRule> element is ignored.

Attributes

<runUntilDeactivated> has no attributes.

Contained within

<runUntilDeactivated> is contained within the following element:

Contains

<runUntilDeactivated> contains no elements.