Boosting documents from the admin UI

Valid from 5.0

Note that besides this admin UI, you can also Boost documents graphically directly from the Search UI

In order to access the admin UI described bellow, you need to be authenticated in Datafari as a user with the "SearchExpert" or the "SearchAdministrator" privilege. For more details refer to the Types of users.

This UI allows you to create, modify or remove existing elevate boosts. If you have graphically boosted documents, it is in this UI that you manage these boosts, and also where you need to activate them.

image-20240314-152855.png

Let's start with the modify/remove part :

image-20240314-152955.png

As you can see, it is composed of two sections :

  • The first one is a "Select" where you will be able to select a query which contains elevated documents. The list only contains queries that are present in the elevate.xml file located in [Datafari_Home]/solr/solr_home/FileShare/conf.

  • The second one is a table where the listed documents have an elevate boost for the query you have selected.
    The documents are ordered by priority of appearance in the search results, which is also indicated by their "Position" number.
    Here you can simply drag and drop the documents to change their position in the search results. You can also remove some of them if you want by clicking on their associated trash icon.

Once you are satisfied with the order of the documents for the selected query, you can click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will send it to Zookeeper and then reload the Solr collection so your modifications will take effect at the end of the process. Once the Solr collection is reloaded, a confirmation message will appear next to the "confirm" button.

Reloading the Solr collection may lead to an interruption of service of Datafari that will last for few seconds to few minutes depending on the size of your index. So you need to be careful when using this feature. To do and save your modifications without reloading the Solr core, use the Search UI feature instead.

Let's focus now on the create part:

This part allows you to create or add elevate boosts for a query. Notice that if you add new elevate boosts to a query which already has ones, the new ones will be added at the top of the list in the same order as you have entered them.

Simply type a query in the corresponding text field and then enter the id of the documents you want to elevate for this query. You can add several documents by clicking on the green cross which will add a new document ID line.

Once your are done with your configuration, click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will reload the Solr core so your modifications will take effect at the end of the process. Once the Solr core is reloaded, a confirmation message will appear next to the "confirm" button.


Note that besides this admin UI, you can also Boost documents graphically directly from the Search UI

This UI allows you to create, modify or remove existing elevate boosts. If you have graphically boosted documents, it is in this UI that you manage these boosts, and also where you need to activate them.

Let's start with the modify/remove part :

As you can see, it is composed of two sections :

  • The first one is a "Select" where you will be able to select a query which contains elevated documents. The list only contains queries that are present in the elevate.xml file located in [Datafari_Home]/solr/solr_home/FileShare/conf.

  • The second one is a table where the listed documents have an elevate boost for the query you have selected.
    The documents are ordered by priority of appearance in the search results, which is also indicated by their "Position" number.
    Here you can simply drag and drop the documents to change their position in the search results. You can also remove some of them if you want by clicking on their associated trash icon.

Once you are satisfied with the order of the documents for the selected query, you can click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will send it to Zookeeper and then reload the Solr collection so your modifications will take effect at the end of the process. Once the Solr collection is reloaded, a confirmation message will appear next to the "confirm" button.

Let's focus now on the create part:

This part allows you to create or add elevate boosts for a query. Notice that if you add new elevate boosts to a query which already has ones, the new ones will be added at the top of the list in the same order as you have entered them.

Simply type a query in the corresponding text field and then enter the id of the documents you want to elevate for this query. You can add several documents by clicking on the green cross which will add a new document ID line.

Once your are done with your configuration, click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will reload the Solr core so your modifications will take effect at the end of the process. Once the Solr core is reloaded, a confirmation message will appear next to the "confirm" button.


From version 2.3 of Datafari, a new feature is available for the "SearchExpert" and "SearchAdministrator" users in the admin UI, the "Query Elevator" :

This UI allows you to create, modify or remove existing elevate boosts.

Let's start with the modify/remove part :

As you can see, it is composed of two sections :

  • The first one is a "Select" where you will be able to select a query which contains elevated documents. The list only contains queries that are present in the elevate.xml file located in [Datafari_Home]/solr/solr_home/FileShare/conf.

  • The second one is a table where the listed documents have an elevate boost for the query you have selected.
    The documents are ordered by priority of appearance in the search results, which is also indicated by their "Position" number.
    Here you can simply drag and drop the documents to change their position in the search results. You can also remove some of them if you want by clicking on their associated trash icon.

Once you are satisfied with the order of the documents for the selected query, you can click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will send it to Zookeeper and then reload the Solr collection so your modifications will take effect at the end of the process. Once the Solr collection is reloaded, a confirmation message will appear next to the "confirm" button.

Let's focus now on the create part:

This part allows you to create or add elevate boosts for a query. Notice that if you add new elevate boosts to a query which already has ones, the new ones will be added at the top of the list in the same order as you have entered them.

Simply type a query in the corresponding text field and then enter the id of the documents you want to elevate for this query. You can add several documents by clicking on the green cross which will add a new document ID line.

Once your are done with your configuration, click on the "confirm" button. Datafari will update the elevate.xml file to match your configuration and will reload the Solr core so your modifications will take effect at the end of the process. Once the Solr core is reloaded, a confirmation message will appear next to the "confirm" button.