Similar Results Widget

• Type: Story
• Status: Closed
• Priority: Minor
• Resolution: Completed
• Affects Version/s: None
• Fix Version/s: 7.2.X, 7.3.0 CE GA1, Master
• Component/s: Search Infrastructure
• Labels:
  • ee-bp
  • fc_19_11
  • marketplace-portal-search-similar-results-1.0.0-7210
  • search-acceptance-usecase
• Branch Version/s:
  7.2.x
• Backported to Branch:
  Committed
• Story Points: 34
• Epic Link: Similar Results
• Sprint: Search | S03 Sprint 3, Search | S03 Sprint 4, Search | S03 Sprint 5, Search | S03 Sprint 6, Search | S03 Sprint 7, Search | S03 Sprint 8
• Git Pull Request: https://github.com/brianchandotcom/liferay-portal/pull/80117

Documentation:

• https://learn.liferay.com/dxp-7.x/using-search/search-pages-and-widgets/similar-results.html
• https://learn.liferay.com/dxp-7.x/using-search/developer-guide/writing-a-similar-results-contributor.html

---

Acceptance Criteria

General

• Site administrators can put a Similar Results widget on a page.
• If there is no main asset (either we can't detect the main document or none exists):
  • For site administrators, display the following info message: "There are no similar results available."
  • For end users, do not display a message. The widget is empty.
• When a main asset is detected, the Similar Results widget will show similar results of the same asset type.
  • Note: Future versions will support displaying mixed asset types
• API extension points to support any type of indexed document

Asset Publisher Page

1. Create a widget page with an Asset Publisher widget and a Similar Results widget.
2. Go to Asset Publisher's  Configuration and set Display Settings > Asset Link Behavior to Show Full Content. (This will display the content of the asset inside the Asset Publisher.)
3. Create multiple similar assets of the types listed below. (similar enough that the Similar Results widget would populate results)
   • Blog Entries
   • Documents and Media files
   • Documents and Media folders
   • Web Content
   • Wiki Pages
   • Message Boards threads
   • Message Boards messages
   • Message Boards categories
4. When clicking on an asset within the Asset Publisher widget, users should see results appear in the Similar Results widget.
5. When clicking on an asset within the Similar Results widget, users should see that asset rendered on the Asset Publisher widget on the current page.

Asset-specific Display Pages

1. Create a widget page with a Blogs widget and a Similar Results widget.
2. Create multiple similar blogs. (similar enough that the Similar Results widget would populate results)
3. When clicking on a blog within the Blogs widget, users should see results appear in the Similar Results widget.
4. When clicking on a blog within the Similar Results widget, users should see that blog rendered on the Blogs widget on the current page.
5. Repeat the above substituting the following widgets and assets
   • Widget: Blogs, Asset: Blog Entry
   • Widget: Documents and Media, Assets: File, Folder
   • Widget: Web Content Display, Asset: Web Content (decided not to implement due to reason stated in note below)
     • Note: This may not be possible via URL detection because the widget does not provide context of the selected asset in the URL.
   • Widget: Wiki, Asset: Wiki Page
   • Widget: Wiki Display, Asset: Wiki Page (decided not to implement due to reason stated in note below)
     • Note: This may not be possible via URL detection because the widget does not provide context of the selected asset in the URL.
   • Widget: Message Boards, Asset: Threads, Messages, Categories

Configuration Options

• General configuration section showing:
  • The maximum number of items to display via an input field.
  • Display Template drop down list with the following options:
    • Three default display templates: Title, Detail, Card. (Figma)
    • All Widget Templates created by administrator
  • Link to "Manage Templates" which allows administrators to CRUD Widget Templates
• Advanced configuration section showing Elasticsearch's More Like This query parameters