Search Enhancements (UXPROD-1705)

[UXPROD-3073] Display exact hit count from RMB Created: 14/May/21  Updated: 31/Aug/21

Status: Open
Project: UX Product
Components: None
Affects versions: None
Fix versions: None
Parent: Search Enhancements

Type: New Feature Priority: TBD
Reporter: Julian Ladisch Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: result-count, search_enhancements, search_result
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
is blocked by RMB-673 totalRecords returns exact hit count ... Closed
Epic Link: Search Enhancements
Front End Estimate: Small < 3 days
Front End Estimator: Julian Ladisch
Front-End Confidence factor: High
Back End Estimate: Out of scope
Back End Estimator: Julian Ladisch
Estimation Notes and Assumptions: Front End Estimate is the sum of work required for all affected modules and forms.
Development Team: None
PO Rank: 0
Rank: Cornell (Full Sum 2021): R2
Rank: GBV (MVP Sum 2020): R2

 Description   

Current situation or problem:

When running a search the front-end displays an estimated hit count.

It should fetch and display the exact hit count that Raml-module-builder (RMB) can calculate since RMB v30.2.4 and v31.0.0 ( RMB-673 Closed ).

In scope

Back-end modules that are based on RMB.

Out of scope

Modules not based on RMB are out of scope.

Using Solr, OpenSearch or Elastic Search is out of scope because it requires considerable effort to set up this additional search solution and requires a case-by-case decision whether a specific module should use it. See Technical Council discussions.

Use case(s)

All search forms that show a hit count along with the search result.

Proposed solution/stories

If totalRecords >= 1000 display "about {totalRecords}" and run a second query to fetch the exact hit count. As soon as the exact hit count has been returned replace the estimation by the exact count and remove the "about " prefix.

No back-end work is needed because all RMB based back-end modules have already been upgraded to RMB >= v31.0.0.

The front-end work is very small for a single form and small when summing up the work required for all affected modules and forms.

Links to additional info

Section "Estimated totalRecords" in RMB documentation: https://github.com/folio-org/raml-module-builder#estimated-totalrecords

Key points:

  • If totalRecords is less that 1000 it is always exact.
  • Otherwise it is an estimation.
  • Use the "limit=0" parameter to fetch the exact hit count.
  • The 1000 threshold is configurable per module only, not per tenant, not per table, not per installation.

Questions


Generated at Fri Feb 09 00:29:08 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.