How To
Documentation
    Learn More

      General Configurations

      Table of Contents

      General configurations are used to characterize a rule, including it’s name, description, group, and more. They are also used to set a rule’s precedence, or priority over other rules.

      Configuration options

      Required Parameter Description Example

      Name

      A user-friendly name for the rule.

      headphones-sale-01

      Description

      A description of the rule for the person who manages business rules. This is an arbitrary value which has no effect on the rule’s purpose or execution.

      "Rule for the upcoming sale on headphones. Boosts limited stock items."

      Rule Group

      See Rule Group for more information.

      Tags

      See Tags for more information.

      browse-rule, search-rule

      Precedence

      Determines when rules should take effect in relation to other triggered rules. A higher number means higher precedence. For example, a rule with precedence of 10 will take effect before a rule with precedence of 3.

      10

      Enabled

      Determines whether the rule is enabled. If set to false, the rule will not fire under any conditions.

      true