Rule editor

The Rule editor lets you configure various rule parameters including zones, styles, and rule groups.

The Rule editor contains a unique name for this rule. In addition, it contains the following tabs:

General

The General tab contains the following fields:

Option	Description
Zone	A list of all available zones.
Style	A list of all available styles.
Member of this rule group	If this project uses rule groups, a list of all available rule groups. (If this project does not contain rule groups, this field is disabled.
Sort key	Optional. A list of sortable dimensions and Endeca properties. [None] indicates that the rule has no record order.
Shuffle	If checked, shuffles the promoted records for the rule.
Self-Pivot	The Self-Pivot feature prevents business rules from displaying duplicate records in merchandising and search results lists when the trigger and target of the business rule contain the same dimension values. With Self-Pivot unchecked, the MDEX Engine looks at each dimension value in the current navigation state. If any of those dimension values exists in the rule's target, the rule will not fire. When checked, Self-Pivot allows business rules to fire even if the user navigates to a location which explicitly contains a dimension value already in the rule target. In version 5.1.4 and later, self-pivot is enabled by default for each new rule created in Endeca Workbench, and the option is not displayed in Endeca Workbench. However, you can change the default and set the check box to display on the Triggers tab in Endeca Workbench. Please refer to the Endeca Advanced Development Guide for more information.
Order	If a sort key is selected, specifies whether the sort order will be ascending or descending.
User profile	Optional. A user profile that must be present in the query in order for the rule to fire. There can only be one user profile per rule.

Triggers

The Triggers tab contains the following field:

Option	Description
Rule is triggered by any of these conditions	A list of triggers that can be made up of any combination of keywords and dimension values.

Time Triggers

The Time Triggers tab contains the following fields:

Option	Description
Give this rule a time trigger	Enables a time trigger for the rule. A trigger specified on this tab is a date/time value that indicates the time at which to start the rule's trigger and the time at which the trigger ends. Any matching query that occurs between these two values triggers the rule.
Start time	Specifies the time after when the rule can be triggered by user queries. Only a start time value is required for a time trigger.
Give this rule an expiration date	Enables the Expiration time field. If you do not specify an expiration time, the rule can be triggered indefinitely.
Expiration time	Specifies the time after which the rule can no longer be triggered.

Targets

The Targets tab contains the following fields:

Option	Description
Targets	A list of target dimension values.
Augment navigation state	If checked, target dimension values are added to the existing navigation state when evaluating the rule. If not checked, evaluation of that rule ignores all current navigation state filters (such as dimension value selections, record search, range filters, and so on) except custom catalog filters.

Properties

The Properties tab contains the following field:

Option	Description
Property/value table	Specifies any rule properties that you want to return as supplementary information with the promoted record pages. You can add multiple properties to a rule. Such properties can be used to specify editorial copy, point to rule-specific images, and so on. These properties can then be accessed with the same method calls used to access system-defined properties that appear in your Endeca application. To add a property: Type the key name in the Key field and its corresponding value in the Value field. Click Add.

Option

Description

Property/value table

Specifies any rule properties that you want to return as supplementary information with the promoted record pages. You can add multiple properties to a rule. Such properties can be used to specify editorial copy, point to rule-specific images, and so on. These properties can then be accessed with the same method calls used to access system-defined properties that appear in your Endeca application.

To add a property:

Type the key name in the Key field and its corresponding value in the Value field.
Click Add.

Featured Records

The Featured Records tab contains the following fields:

Option	Description
Record spec	A list of dimensions and Endeca properties that can be used for the record specifier. [None] indicates no dimension or Endeca property has been selected.
Record spec values	A list of the record identifiers that you type into the Value text box.