timerRule element

The <timerRule> element defines a rule according to the timer pattern.

Attributes

<timerRule> has the following attributes:

Table 1. Attributes of the <timerRule> element
Name Description Data type Required?
name Identifies the rule. This identifier must be unique within the rule block that contains this rule. It cannot contain a period. xsd:NMTOKEN Yes
processOnlyForwardedEvents This attribute is ignored because the timer rule does not process events. xsd:boolean No
repeat Defines whether the timer rule runs repeatedly until it is deactivated. The valid values are:
  • true (the default value)
  • false

If the value is set to false, the rule runs through its time interval only once, executes the rule response action when the respective time window is complete, and stops.

If the <timeWindow> element for the timer rule contains the <runUntilDeactivated> element, the repeat attribute is ignored.

xsd:boolean No

Contained within

<timerRule> is contained within the following element:

Contains

<timerRule> contains the following elements.

The elements must be coded in the order that is shown. If an element is optional, it does not need to be coded, but all elements that are coded must follow the correct order.

Table 2. Elements contained within the <timerRule> element
Element Required or optional?
<comment> Optional. 0 or 1 occurrence is allowed.
<variable> Optional. 0 or more occurrences are allowed.
<activationInterval> Optional. 0 or 1 occurrence is allowed.
<lifeCycleActions> Optional. 0 or 1 occurrence is allowed.
<timeWindow> Required. Only 1 occurrence is allowed.
<onTimeWindowComplete> Optional. 0 or 1 occurrence is allowed.
Related concepts
Timer pattern