[UXPROD-2702] Display Rounded Result Counts in Apps Using SearchAndSortQuery (i.e. Users) Created: 30/Sep/20 Updated: 07/Dec/20 Resolved: 07/Dec/20 |
|
| Status: | Closed |
| Project: | UX Product |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | New Feature | Priority: | TBD |
| Reporter: | Cate Boerema (Inactive) | Assignee: | Cate Boerema (Inactive) |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | elastic-search, result-count, search, searching | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Attachments: |
|
||||||||||||||||
| Issue links: |
|
||||||||||||||||
| Front End Estimate: | Very Small (VS) < 1day | ||||||||||||||||
| Front End Estimator: | Zak Burke | ||||||||||||||||
| Back End Estimate: | Small < 3 days | ||||||||||||||||
| Back End Estimator: | Bohdan Suprun (Inactive) | ||||||||||||||||
| Estimation Notes and Assumptions: | BE: All the logic is handled by RMB, CF team will only migrate to the proper version of the RMB and update interface versions.
FE: Low estimate based on doing most of the threading-values-through work in |
||||||||||||||||
| Development Team: | Prokopovych | ||||||||||||||||
| PO Rank: | 96 | ||||||||||||||||
| PO Ranking Note: | 2020-10-05: Setting high PO rank, as this is necessary to complete the work Core Platform has started in |
||||||||||||||||
| Rank: Cornell (Full Sum 2021): | R1 | ||||||||||||||||
| Rank: 5Colleges (Full Jul 2021): | R2 | ||||||||||||||||
| Rank: GBV (MVP Sum 2020): | R3 | ||||||||||||||||
| Rank: MO State (MVP June 2020): | R3 | ||||||||||||||||
| Rank: TAMU (MVP Jan 2021): | R2 | ||||||||||||||||
| Description |
|
Purpose: The scope of this work is to display the rounded result counts in apps using the SearchAndSortQuery component: ui-users and ui-plugin-find-user. A separate feature has been created for apps using the SearchAndSort component:
This work will be done by Core Functional after Core Platform has developed the infrastructure as part of
Description of work: The totalRecords search result hit count number returned by RMB is precise if totalRecords is below 1000 and it is only an estimation if totalRecords >= 1000 (details). "about" should be prepended for >= 1000. The number should be rounded for >= 1000. Algorithm for the front-end: if totalRecordsEstimated is true print "about " + totalRecordsRounded else if totalRecordsEstimated is false print totalRecords // totalRecordsEstimated is undefined until all back-ends have upgraded RMB, // handle this gracefully for folio-testing: else if totalRecords < 1000 print totalRecords else print "about " + totalRecords + " (upgrade back-end for rounding)" Story outline:
Scenarios:
Background Discussion:
Details on Rounding Options Considered: 3 rounding proposals are in the comments of MODINVSTOR-468: A) Round to magnitude:
B) Round to first digit:
C) Round first digit to 1, 2 or 5:
This issue is about deciding whether there should be a FOLIO standard for rounding, and if yes, which to choose, and whether the front-end or the back-end should round the number. Proposed API as of July 28, 2020 If the back-end rounds it should also provide to original (non-rounded) estimate, for example
totalRecords: 1431
totalRecordsRounded: 1000
totalRecordsEstimated: true
No rounding is needed for an exact number:
totalRecords: 1509
totalRecordsEstimated: false
https://github.com/folio-org/raml/blob/raml1.0/schemas/resultInfo.schema needs to be extended accordingly. |
| Comments |
| Comment by Cate Boerema (Inactive) [ 30/Sep/20 ] |
|
Making an exception and carrying over rankings when splitting this feature from
|
| Comment by Cate Boerema (Inactive) [ 30/Sep/20 ] |
|
Zak Burke and Bohdan Suprun could you please provide high-level estimates for this feature? If you think more stories are needed than what I have listed in the "story outline", please let me know. |
| Comment by Bohdan Suprun (Inactive) [ 30/Sep/20 ] |
|
It is 2-3 days, all the logic will be part of RMB, Core Functional will have to update modules to proper version of RMB and update versions of the API. |
| Comment by Cate Boerema (Inactive) [ 07/Dec/20 ] |
|
Closing as Won't Do because Elastic search should offer exact hit counts, thus obviating this issue cc: Charlotte Whitt |