Business Rules

LucidAcademyLucidworks offers free training to help you get started.The Course for Query Rewriting with Business Rules and Search Rewrites focuses on how using business rules and search rewrites gives you the opportunity to boost conversions and create better customer experiences by improving your relevancy:

Visit the LucidAcademy to see the full training catalog.

​

Facet rules

​

Facet menu

1. Click the date start value. A calendar will appear.
2. Click a date to select the start of your facet range.
3. Click the bottom date and select the end of your facet range.

​

Search

​

Rules

​

Create a rule

1. Click the button in the top-right corner of the card. Alternatively, click the button in the bottom-left corner of the card. The New Rule dialog box will appear.
2. Complete the required fields, at a minimum.

   General	Condition	Action
   In the General column, only the Name field is required. Other fields are optional: Description is an arbitrary string you can use to describe this rule. Rule Group can be a user-defined group that you use to organize your rules. Tags are another way to organize your rules. Tags appear as facets in the Business Rules interface, so you can filter the set of visible rules by tag. Priority can be used to determine which rule should apply first if multiple rules are activated for the same request. Priority is an integer value, ranging from 1 to infinity, with the value 1 given lowest priority. If multiple rules have the same value, those rules are applied in a random order. Enabled means that this rule is applied but not necessarily published. Disabling a rule helps ensure that it is not accidentally published.	Conditions are triggers that activate the rule when they match the current date and time, query, or field values. See Rule conditions for more information.	A rule can take different types of actions when the specified conditions are met. See Action types for more information. You can also create custom actions.

   Hover over the icon for more information.
3. Once complete, click the button.

​

Copy a rule

1. Hover over a rule. A row of buttons will appear on the right.
2. Click the button. The Copy Rule dialog box will appear.
3. At a minimum, change the title of the rule.
4. Once complete, click the button.

​

Edit a rule

1. Hover over a rule. A row of buttons will appear on the right.
2. Click the button. The Edit Rule dialog box appears.
3. Make your desired changes to the rule.
4. Once complete, click the button.

​

Approve/deny rules

1. Hover over a rule. A checkbox will appear on the left.
2. Click the checkbox to select the rule.
3. Repeat this process to select multiple rules. (optional)
4. Click the Approve button to approve the selected rules, or click the Deny button to deny the rules.

​

Enable/disable a rule

1. Hover over a rule. A checkbox will appear on the left.
2. Click the checkbox to select the rule.
3. Repeat this process to select multiple rules. (optional)
4. Click the button to enable the selected rules, or click the button to disable the rules.

​

Publish a rule

1. Hover over a rule. A checkbox will appear on the left.
2. Click the checkbox to select the rule.
3. Repeat this process to select multiple rules. (optional)
4. Click the button to publish the selected rules.

​

Tag a rule

1. Hover over a rule. A checkbox will appear on the left.
2. Click the checkbox to select the rule.
3. Repeat this process to select multiple rules. (optional)
4. Click the button. A dialog box will appear.
5. Enter a tag. To enter multiple tags, press Tab after writing each tag.
6. Click the button to add the tag to the rule.
   See General Configuration Tags for information about how to use tagnames in the request URL to fire specific rules.

​

Delete rules

​

Delete a single rule

1. Hover over a rule. A row of buttons will appear on the right.
2. Click the button. A confirmation box will appear.
3. Click the button to confirm.

​

Delete multiple rules

1. Hover over a rule. A checkbox will appear on the left.
2. Click the checkbox to select the rule.
3. Repeat this process to select multiple rules. (optional)
4. Click the button to delete the selected rules. A confirmation box will appear.
5. Click the button to confirm.

​

Sort rules

1. Hover over column titles. A icon will appear for some titles to indicate the rules list can be sorted by that column.
2. Click on the title column to sort the rules.

The column that is currently sorting the rules list is indicated by an or icon.

​

Export rules

To export the rules list, simply click the button. This generates a .csv file containing your rules.

​

Columns

​

Customize columns

1. Hover over the row of column titles. A button will appear on the right.
2. Click the button. The Customize Columns to Display dialog box will appear.
3. Click the checkboxes to select or deselect the columns you want to display.
4. Click the button to save your changes.

1. Create a query pipeline, custom-rule-pipeline, that is used to complete the rule action.
2. Create a custom rule type, custom-rule-type, that uses your query pipeline. Here are some important parameters to include in your POST request.
   Rule properties, included as part of the schema</code, define the values required from the user to create a rule that uses the custom rule type.
   ​

   id

   required

   A unique ID for the custom rule type. The id value must be unique across all apps in Fusion (global namespace).
   Example: custom-rule-type
   ​

   pipeline_id

   required

   The ID of the pipeline that is invoked during rule processing.
   Example: custom-rule-pipeline
   ​

   display_type

   required

   A user-friendly name for the custom rule type.
   Example: My Custom Rule
   ​

   custom_param1

   required

   The ID of the rule’s parameter. This field is used in the API but is not visible in the Rules Editor.
   Example: 1st-rule-parameter
   ​

   type

   required

   The type of user-input.
   Example: string
   ​

   title

   required

   A user-friendly name for the parameter.
   Example: Manufacturer
   ​

   description

   required

   A user-friendly description of what the field is used for. The description value is shown in the field’s tooltip in the Rules Editor.
   Example: The manufacturer of the product to which this rule applies.
   For example:
   Copy

   curl -u USERNAME:PASSWORD -XPOST -H "Content-type:application/json" \
   https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/myFusionApp/custom-rule-types -d '{
   "id":"custom-rule-type",
   "pipeline_id":"custom-rule-pipeline",
   "display_type":"My Custom Rule",
   "schema": {
       "type" : "object",
       "properties" : {
       "custom_param1" : {
           "type" : "string",
           "title" : "Manufacturer",
           "description" : "The manufacturer of the product this rule action applies to."
       },
       "custom_param2" : {
           "type": "string",
           "title": "Type",
           "description": "The type of product this rule action applies to."
       }
       }
   }
   }'
   

3. Verify the custom rule type was created by visiting https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/myFusionApp/custom-rule-types. Custom rule types are also available in the Rules Editor:
4. Create a rule, custom-rule-action, that uses your custom rule, custom-rule-type. If you are creating the rule using the Query Rewrite API, the following image depicts which parameters are shared between the custom rule type and the rule: Note that the custom rule type id value is used for the rule’s type and custom_type fields. Remember to assign values to the custom rule properties, custom_param1 and custom_param2.
   Copy

   curl -u USERNAME:PASSWORD -XPOST -H "Content-type:application/json" \
   https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/myFusionApp/query-rewrite/instances -d '{
     "id":"123456",
     "type":"custom-rule-type",
     "custom_type":"custom-rule-type",
     "name":"My Rule",
     "description":"A rule that uses my custom rule, custom-rule-type.",
     "search_terms":["upcoming sale"],
     "custom_param1":"ABC",
     "custom_param2":"XYZ",
     "pipeline_id":"custom-rule-pipeline",
     "display_type":"My Custom Rule"
   }'
   

5. Verify your rule was created by checking the rule ID, 123456, with the Query Rewrite API: https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/myFusionApp/query-rewrite/instances/123456
6. Test your custom rule using your normal rule development process.

1. Create an XML file named elevate.xml in the same directory as the solrconfig.xml file.
2. Use the following as the contents of the elevate.xml file:
   Copy

   <?xml version="1.0" encoding="UTF-8" ?>
   <elevate>
   </elevate>
   

3. In the solrconfig.xml file, add the following in the elevator search Component (searchComponent name="elevator"). Before adding, check to see if the searchComponent already exists within the file.
   Copy

     <searchComponent name="elevator" class="solr.QueryElevationComponent" >
       <str name="config-file">elevate.xml</str>
     </searchComponent>
   

4. Add elevator as a ‘last component’ part of the select handler in the solrconfig.xml file. If a last-components array is not already defined, create it at the end of the select handler’s configuration. If one is already defined, add <str>elevator</str>.
   Copy

     <requestHandler name="/elevate" class="solr.SearchHandler">
       <arr name="last-components">
         <str>elevator</str>
       </arr>
     </requestHandler>
   

5. When you create a new business rule, check the USE QUERY ELEVATION COMPONENT checkbox to use elevation.