Rule task properties

You can edit the properties for the rule task of a ruleflow.

To edit the properties for a rule task, click it in the Diagram page of the Ruleflow Editor.

The following properties are available in the Properties view:

Table 1. Rule Task tab

Property

Purpose

An ID is the technical name for a rule task. All ruleflow elements have an ID that identifies them in an XML schema.

In Rule Designer Java, the ID of a rule task generates the IRL code executes at run time. To view this code, click the IRL tab under the Ruleflow Editor.

If you duplicate a rule task in a ruleflow, it has a unique ID.

IDs are not locale dependent. When you specify an ID, it is good practice to use only characters (a-z, A-Z) and numbers (0-9).

Label

You can specify a label for the rule task that appear in the Diagram page. A label has no impact on the IRL that is generated.

Labels are locale dependent. You can specify different labels in a new locale and recover the labels in the original locale for elements that do not change. For example, if you change the ID of a rule task, you lose the labels defined for the rule task in all other locales except the original.

When you specify a label, it is good practice to use only characters (a-z, A-Z) and numbers (0-9).

Algorithm

Use this section to specify the processing algorithm for the rule task:

RetePlus
Sequential
Fastpath

See Engine execution modes for more information.

Exit Criteria

Use this section to specify if all rules, one rule, or one rule instance execute:

None: The default setting that all rules are executed until conditions terminate execution. The rules are executed in a particular order determined by the selected ordering.
Rule: Execution terminates after the chosen rule is executed, according to the selected algorithm.
RuleInstance: A single instance of one rule is executed. This rule is determined by the selected ordering.

Ordering

Use this section to specify the order of rule execution in a rule task as follows:

Default: The algorithm determines the execution order.
Literal: The order of the rules in the rule task determines the order of rule execution
Priority: the rules are executed following a static priority in decreasing order.

Note: If you try to use the literal or priority mode with the RetePlus algorithm, an error message warns you in the Problems tab of Rule Designer. This usage is deprecated. Use those ordering modes with the sequential or the Fastpath algorithm.
For more information, see ordering.

Advanced properties

The following table summarizes some features you can set using advanced properties.

Table 1. Some features set by advanced properties
Advanced property	Description
`firinglimit = n;`	This property sets a specific number of rule executions. To use an execution limit, set `exitCriteria` to none and in Advanced Properties add `firing = allrules\|rule` and `firinglimit = n, n>0`. For `n = 0` use the Exit Criteria options.

Table 3. Rule Selection tab
Property	Purpose
List the rules and rule packages in the rule task	Use this property to list the rules and rule packages that are considered when the rule task is executed. To edit this list and reorder it, use the Up and Down buttons.
Dynamic BAL	Use this property to specify runtime rule selection using a dynamic statement BAL. The property runs each time you call the task.
Static BAL	Use this property to specify runtime rule selection using static statement in BAL. The property runs the first time that you call the task.
IRL	Use this property to specify runtime rule selection using IRL. Define a rule filter in IRL with `"body = ...."`

Table 4. Initial Action tab
Property	Purpose
Initial Action	The action that launches before the task starts. Select Use BAL for action to define the action in BAL, or enter other code.

Table 5. Final Action tab
Property	Purpose
Final Action	The action that launches after the task ends. Select Use BAL for action to define the action in BAL, or enter other code.

Table 6. Documentation tab
Property	Purpose
Documentation	This property provides optional information about the rule task. Use this property to provide notes, comments, and other useful information that appears as a tooltip.