Business Rules:
Custom Rule Actions

Custom rule actions allow you to define a unique action to take when certain conditions are met. They involve three primary components: a query pipeline, a custom rule type, and a rule that is triggered by conditions defined by the user.

Note
This rule type is only supported on Legacy requests. Application to DSL requests is unsupported.

To learn use custom rule actions with the API, see Create Custom Rule Actions with the API.

The custom rule components serve the following purposes:

  • Query pipeline - Determines the action that takes place when the rule conditions are met by processing the query with query pipeline stages. The query pipeline is created using the Query Pipelines API or the Fusion UI. Typically, the query pipeline is reserved for the custom rule type only, but this is not a requirement.

    Important
    Do NOT use the main query pipeline, which holds the same name as the app itself, in a custom rule. An exception error will occur.
  • Custom rule type - Defines the rule parameters and specifies the query pipeline used to perform the action. The custom rule type is created using the Custom Rules API.

  • Rule - Defines the conditions that must be met for the rule to fire. The rule is created using the Query Rewrite API or the Fusion UI.