Collection form
|
|
Complete this tab to identify the rules in the collection, the sequence in which they execute, and preconditions. Rows on this tab are called steps, similar to the steps in an activity.
During the first phase of collection processing, the system uses the steps on this tab to assemble a candidate list of rules to execute. See Collect method for additional details.
During the second phase, preconditions are evaluated for each row (except as noted) to determine whether the rule identified in that row is retrieved and executed. If the rule executes, any forward chaining processing is performed for that row before the system begins any processing for the next row.
This tab has two alternate layouts: Basic Collection and Advanced Collection. You toggle them by selecting the Show Advanced Options? checkbox in the Preamble and Stop tab. See Collection form — Completing the Preamble and Stop tab .
Basic Collection (default) — Use this tab to execute a decision tree, decision table, or map value in a step. Step pages are not enabled. Only when rules can be used as preconditions.Field | Description |
Define Collection Specifications | Complete the rows of this array to identify the rules that form the collection. Order is significant; at runtime, rows are evaluated starting at the top. To reorder the rows of this array, hold the mouse pointer over a number. Click and drag to another row. To duplicate or move a row, hold the mouse pointer over a number. Or, right-click to access a context menu with Cut, Copy, and Insert options. |
Description | Optional. Enter a brief text description of this step. |
When | Optional. Select a when condition rule, or an expression that must evaluate to true for the step to execute. |
Execute | Identify the type of decision rule to execute:
|
Rule | Specify here the name — second key part — of the rule to be executed in this step. This is a rule of the type identified in the Execute field. |
Rule Resolution Qualifiers | Optional. The following describe the qualifiers available for decision trees, decision tables, or map values that are available in the Rule Resolution dialog. To open the dialog, click at the end of the row. When you select the checkbox and enter a property reference or literal value in the adjacent text field, rule resolution selects one of the following:
These temporary values do not affect rule resolution for preconditions. |
Override Circumstance Property Value? | Select to indicate that while rule resolution searches for the decision tree, decision table, or map value identified in this row, a replacement value is temporarily used for the Circumstance Property. The original property value is restored after the step completes (unless the value is changed again during the course of the step). |
(no label) | Enter an expression that at runtime provides the temporary Circumstance Property value. The system evaluates replacement value only once at runtime, before any other collection processing (including presets) is performed. |
Override Circumstance Date Property Value? | Select to indicate that while rule resolution searches for the decision tree, decision table, or map value identified in this row, a replacement value is temporarily used for the Circumstance Date Property. The original property value is restored after the step completes (unless the value is changed again during the course of the step). |
Enter an expression that at runtime provides the temporary Circumstance Date Property value. The system evaluates this expression only once at runtime, before any other collection processing (including presets) is performed. | |
Override Rule Resolution Date? | Select to indicate that while rule resolution searches for the decision tree, decision table, or map value identified in this row, a replacement value is used rather than the true current date and time. This can cause a time-qualified rule to be selected that otherwise would not be selected with the true current date and time. |
Enter a literal |
Advanced Collection — Use this tab to execute a collection, list view, activity, or Declare Expression rule (in addition to the basic decision rules described above). You can specify a step page for the rule. The following table describes fields that are unique to the Advanced Collection tab:
Field | Description |
Precondition Type | Optional. To cause the rule in this row to execute only when certain conditions are met, specify the type of rule, or
If the Execute field for this row has the value |
Step Page | Specify the name of a page for the precondition and the rule in this step. Include this page name and a class for the page on the Pages and Classes tab. |
Execute | Identify the type of the rule to execute in the context of the Step Page page.
Decision Tree, Decision Table, and Map Value are also available on this tab as described previously. |
Rule | Specify here the name of the rule to be executed in this step. This is a rule of the type identified in the Execute field. The system uses the class of the page in the Step Page field to locate this rule at runtime. |
Another collection | The name — second key part — of the collection rule to be executed in this step. The system uses the class of the page in the Step Page field to locate this rule at runtime. You can specify how duplicate rules are handled and modify input parameters by clicking at the end of the row to open the Collections Parameter dialog. Duplicate Handling — By default, all rules are executed in both collections. You can control how the system consolidates rules already encountered with rules of the other collection rule at runtime. In the Duplicate Handling field, select one of the following:
Optional: Use the Collection fields to modify the rule you specified in the Execute field. Parameters — Use this section to modify the parameter values (if any) specified in the collection rule (not the one identified in the Execute field). |
Declare Expression | Identify a property reference that may be computed by a Declare Expression rule that has |
List View | Identify the second key part of a list view rule that returns the keys of other rules that are to execute as part of this collection. Reference a list view rule that meets either of two conditions:
The system uses
|
Activity | Identify here the second key part of the activity that is executed in this step. Click to open the Activity Parameters dialog and modify the parameters (if any). |
Because there are fields in the Advanced Collection tab that do not appear in the Basic Collection tab, entered (saved or unsaved) values will change when switching between tabs:
Basic to Advanced: Decision Tree, Map Value, and Decision Table Execute and Rule values remain. The When rule appears in the Precondition Type fields.
Advanced to Basic:
Field values persist when switching between tab formats. For instance, if you entered a list view rule in the Advanced Collection tab, switched to Basic Collection, and then back to Advanced Collection, the original Step Page, Precondition Type, Execute, and Rule values reappear.