Collection form
Completing the Basic / Advanced Collection tab

Field

Description

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.

Optional. Select a when condition rule, or an expression that must evaluate to true for the step to execute.

Identify the type of decision rule to execute:

• Decision Tree — A decision tree.
• Decision Table — A decision table.
• Map Value — A map value.

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.

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:

• A circumstance-qualified rule of that name rather than an unqualified rule.
• A time-qualified rule with a date range that doesn't include "now".

These temporary values do not affect rule resolution for preconditions.

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).

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 mixins) is performed.

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 mixins) is performed.

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 DateTime constant or an expression that at runtime provides the date and time to be used during rule resolution. The system evaluates this expression only once at runtime, before any other collection processing (including mixins) is performed.

Field

Description

Optional. To cause the rule in this row to execute only when certain conditions are met, specify the type of rule, or None. Click to expand the row and display the fields:

• None — No precondition.
• When — A when condition rule, or an expression that evaluates to true or false.
• Decision Tree — A decision tree that evaluates to true or false.
• Decision Table — A decision table that evaluates to true or false.
• Map Value — A map value that evaluates to true or false.

If the Execute field for this row has the value Other Collection, choose a precondition that does not depend on the results of other rules on this tab.

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.
If blank, the system uses the primary page corresponding to the Applies To key part of the collection rule as the step page when evaluating the precondition.

Identify the type of the rule to execute in the context of the Step Page page.

• Another Collection — A collection rule. At runtime, the steps in the Basic / Advanced Collection tab of the specified collection rule are appended to those on this rule's tab and run in sequence.
• Activity — An activity.
• Declare Expression — A Declare Expression rule that meets certain criteria.
• List View — A list view rule that returns the keys of other rules.

Decision Tree, Decision Table, and Map Value are also available on this tab as described previously.

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.

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:

• Include All (default) — No consolidation is necessary. If a rule appears more than once, it executes each time in the ordinary sequence.
• Remove Rules with Same Name — If the rule with this name (pxInsID property) is already in the list, it is removed.  If it is in the list multiple times, then all occurrences are removed. 
• Remove Identical Rules — If the rule with this handle (pzInsKey property) is already in the list, it is removed.  If it appears in the list multiple times, then all occurrences are removed.

Optional: Use the Collection fields to modify the rule you specified in the Execute field.

Identify a property reference that may be computed by a Declare Expression rule that has When applied by a Rule Collection as the value of the Calculate Value field on the Change Tracking tab. The system uses the class of the step page for this step as the Applies To key part to find this Declare Expression rule.

• The Applies To class of the list view rule is Data-Rule-Summary and the list view returns the pyClass and pxInsID properties
• or,
• The Applies To class is a subclass of the Rule- base class and it returns the pxInsID, and pxObjClass properties. (If the list view rule returns other list view rules, include the pyClassName property in the results too.)

The system uses ALL as the third key part to locate the list view rule at runtime. Each pxResults() page that identifies a rule of one of the rule types that can appear in this Execute field becomes a new step; pxResults() pages that identify rules of other types are ignored. The order of results pages is significant.

• How duplicate rules are handled during runtime. See Duplicate Handling above.
• The class of the list view whose results are executed for this step.

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).