User Result Ranker module
| Edition | DX Core |
|---|---|
License |
|
Issues |
|
Maven site |
|
Latest |
2.0.0 |
The User Result Ranker module helps authors to find relevant content fast when searching by boosting search ranking capabilities.
|
The User Result Ranker module requires Periscope module 1.2.10 and later. |
Installing with Maven
Maven is the easiest way to install the module. Add the following to your bundle:
<dependency>
<groupId>info.magnolia.ranker</groupId>
<artifactId>magnolia-user-result-ranker</artifactId>
<version>2.0.0</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
<dependency>
<groupId>info.magnolia.ranker</groupId>
<artifactId>user-result-ranker-jcr</artifactId>
<version>2.0.0</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
Usage
Search results are ranked in the following order:
-
Last used content
If you’ve recently searched for something and clicked on a result, that result is prioritized and appears higher up in your search results the next time you perform a search.
-
Most used content
If no recent results are found, the system prioritizes content that you’ve interacted with frequently in the past. For example, if you previously clicked on a search result for a page titled
Swiss-cheesemultiple times, then it’s displayed at the top of the search results when you search for the word 'Swiss'. -
User group-based recommendations
If neither recent nor frequently used content is available, the system considers recommendations from users in your user group (such as the 'editors' group). For example, if other editors have interacted with a page titled
Swiss-watch, it’s displayed as the top result when you search for 'Swiss' for the first time.
The metrics collected by the User Result Ranker module are stored in the userranking workspace.
Results ranking in the Find Bar
The Find Bar’s ranking functionality (Magnolia DX Core only) enhances search result relevance by leveraging this User Result Ranker module and the Search API endpoint.
When a user selects a search result, the system records the item’s UUID and the current user (retrieved from the session, including their user group for collaborative ranking) via a POST request to the new endpoint.
Results are ranked in order of preference:
-
Recently selected items appear highest.
-
Followed by frequently used content.
-
Finally, you see the recommendations based on the user’s group, for example, the editors.
This dynamic ranking, integrated with the React-based Global Search frontend, ensures a personalized and efficient search experience.
In the Community Edition (CE), ranking is disabled, and the score is always 0.
|