Business Rules:
Actions

Business rule actions define what actions are taken when a rule fires.

For more information, see Business Rules Actions Concepts.

Configuration options

Required Parameter Description Example

Banner URL

The URL of the desired banner image.

https://example-site.com/assets/promotion.png

Banner zone

An arbitrary value used by the frontend, generally to instruct the search application where to place the banner image.

TOP

Block list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Boost attributes

Required Parameter Description Example

Boost param

  • bq - Add additive boost that applies to the main query.

  • boost - A multiplicative boost based on document scores.

boost

Boost query

The query that the boost will apply to.

bq: category_s:"Small Business"^5

boost: category_s:"Small Business"

Boost list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Bury list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Filter list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Ingroup actions

Ingroup boost list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Grouping field

The name of the group field that the rule action applies to. This group field must have a group-field parameter or the rule does not apply.

color_group_name

Ingroup bury list

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Grouping field

The name of the group field that the rule action applies to. This group field must have a group-field parameter or the rule does not apply.

color_group_name

Ingroup pinned

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

title

Field values

The values of the field that the rule action applies to. The field determines what field values are available.

Voyager Jacket

Grouping field

The name of the group field that the rule action applies to. This group field must have a group-field parameter or the rule does not apply.

color_group_name

Pin within a specific group value

The values of the grouping field that the rule action applies to. The field determines what field values are available. Only a single group value is supported.

red

Pinned documents

The individual documents that the rule action applies to.

Summit Pants (red)

Pinned

Required Parameter Description Example

Field name

The name of the field that the rule action applies to. The documents in the datasource determine what fields are available.

id

Pinned documents

Individual documents to pin. Specify the following:

  • Value - The values of the field that the rule action applies to. The field determines what field values are available.

  • Position - Position within the results where the document is pinned, with 1 being the 1st result. Each position is available to only a single document.

Value: 1000026

Position: 4

Redirect

Required Parameter Description Example

Redirect

The URL that the user will redirect to.

https://www.activate-conf.com/

Response value

Required Parameter Description Example

Field name

The name of the field that the response value is found under.

ad-code

Field value

The response value that is included in the results response.

AD_CODE_99

Set facets

Required Parameter Description Example

Position

Position of the facet field in the list of facets, with 1 being the top of the list. Each position is available to only a single facet.

3

Facet field

The name of the facet field.

Color

Facet type

The type of facet:

field - A field found in the datasource.

range - An accepted range for the facet field to exist within. Specify the following:

  • Range start - The lower bounds of the facet range. For example, 0.

  • Range end - The upper bounds of the facet range. For example, 50.

  • Range gap - The increment amount dividing the range, starting from the range start and ending after the range end is encompassed. For a facet range of 1-50 and a range gap of 20, 3 facets are available: 0-20, 20-40, 40-60.

field

Advanced options for field facet types

Select type

Determines whether the user can select a single facet or multiple facets.

multi

Facet sort

Sort order of the individual facets within the facet field:

  • count - Facets are sorted by the number of documents included in the facet in descending order.

  • index - Facets are sorted in alphanumeric order.

count

Min count

Sets a minimum requirement for the number of documents included in the facet in order for the facet to display.

10

Boost values

Boost individual facets within the facet field in the order they are added. This allows you to override the default ordering as determined by the Facet sort option. For example, you may want to boost tshirt and shorts over hoodie during summer months.

tshirt

Bury values

Bury individual facets with the facet field in the order they are added.

hoodie

Suppress values

Prevent individual facets from appearing within the facet field.

coat

Advanced options for range facet types

Select type

Determines whether the user can select a single facet or multiple facets.

multi

Facet sort

Sort order of the individual facets within the facet field:

  • count - Facets are sorted by the number of documents included in the facet in descending order.

  • index - Facets are sorted in alphanumeric order.

count

Min count

Sets a minimum requirement for the number of documents included in the facet in order for the facet to display.

10

Set Params

Required Parameter Description Example

Parameter name

The name of the query parameter.

fl

Parameter value

The value of the query parameter.

discountAmount

Update policy

The manner in which the parameter affects the results response:

  • append - Add the parameter to the default parameters in the results response.

  • default - Add the parameter to the default parameters in the results response if it is not already included in the request or the default specification in the Solr config file solrconfig.xml.

  • remove - Remove the parameter from the results response.

  • replace - Replace the default parameter in the results response.

append

JSON Blob

Required Parameter Description Example

Blob Type

An arbitrary value used by the frontend, generally to indicate what kind of data the JSON blob contains.

default

JSON Blob

An arbitrary JSON value used by the frontend. When the rule is triggered, the JSON is sent with the results response. This behaves similarly to the Banner rule, given that it returns the JSON object outside of the search results.

{"parameter1":"value", "parameter2":["value_a", "value_b"]}

Additional configuration options

  • Set response values - Combine Response Value rules with other rules for purposes as described above.

  • Use Query Elevation Component (QEC) - Apply the rule action to configure the top results regardless of the document’s score. However, enabling QEC does not boost the document’s score. The QEC only supports elevation through the id field. If QEC is enabled but is not configured correctly in Solr, the rule does not fire.

    To use the Query Elevation Component, you must first configure your Solr cluster. Note that query elevation does not boost scores.

The chart below shows additional configuration support for each business rule action:

Action Response value Query Elevation Component

Banner

𐄂

𐄂

Block List

𐄂

Boost Attributes

𐄂

Boost List

Bury List

𐄂

Filter List

Ingroup Boost List

𐄂

Ingroup Bury List

𐄂

Ingroup Pinned

𐄂

Pinned

Redirect

𐄂

𐄂

Response Value

𐄂

Set Facets

𐄂

Set Params

𐄂

Version availability

The following table details which rule actions are available in each Fusion version. The table assumes the latest maintenance version. For example, 5.2 assumes 5.2.2.

Rule type 4.2 5.0 5.1 5.2 5.3

Banner

Block List

Boost Attributes

Boost List

Bury List

Filter List

Ingroup Boost List

𐄂

𐄂

Ingroup Bury List

𐄂

𐄂

Ingroup Pinned

𐄂

𐄂

𐄂

Pinned

Redirect

Response Value

Set Facets

Set Params

JSON Blob

𐄂

𐄂

𐄂

𐄂