Inventory (UXPROD-785)

[UXPROD-1634] Inventory. Result list Refined display rules. Display Resource title in MCL and Sort on Index title Created: 01/Apr/19  Updated: 25/Nov/21  Resolved: 25/Nov/21

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Kiwi (R3 2021)
Parent: Inventory

Type: New Feature Priority: P3
Reporter: Charlotte Whitt Assignee: Charlotte Whitt
Resolution: Done Votes: 0
Labels: metadatamanagement, po-mvp, round_iv, search_result
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File Skärmavbild 2020-07-24 kl. 12.09.08.png     PNG File Skärmavbild 2020-07-24 kl. 12.12.34.png     PNG File Skärmavbild 2021-11-25 kl. 9.40.06 fm.png     PNG File Skærmbillede 2020-11-17 kl. 14.01.49.png     PNG File screenshot-1.png    
Issue links:
Defines
is defined by MSEARCH-136 Title sorting enhancement - Sort by i... Closed
is defined by UIIN-519 Inventory: Instance Sorting. Implemen... Closed
Relates
relates to UX-449 UX: Sort by values for updated invent... Open
relates to FOLIO-1281 define sorting semantics for titles a... Closed
relates to UISE-80 Search results are not sorted by title Closed
Epic Link: Inventory
Analysis Estimate: Very Small (VS) < 1day
Analysis Estimator: Charlotte Whitt
Front End Estimate: Small < 3 days
Front End Estimator: Michal Kuklis
Front-End Confidence factor: Medium
Back End Estimate: Large < 10 days
Back End Estimator: Marc Johnson
Estimation Notes and Assumptions: Will likely required a new derived property for the effective title, in order to do sorting. May involve changes to the keyword searching.
Development Team: Prokopovych
Kiwi Planning Points (DO NOT CHANGE): 1
PO Rank: 133
Rank: Chalmers (Impl Aut 2019): R4
Rank: Chicago (MVP Sum 2020): R1
Rank: Cornell (Full Sum 2021): R1
Rank: Duke (Full Sum 2021): R1
Rank: 5Colleges (Full Jul 2021): R1
Rank: FLO (MVP Sum 2020): R1
Rank: GBV (MVP Sum 2020): R2
Rank: Grand Valley (Full Sum 2021): R1
Rank: hbz (TBD): R1
Rank: Hungary (MVP End 2020): R1
Rank: Lehigh (MVP Summer 2020): R1
Rank: MO State (MVP June 2020): R2
Rank: TAMU (MVP Jan 2021): R1
Rank: Trinity College (Jun 2021): R1
Rank: U of AL (MVP Oct 2020): R1

 Description   

Charlotte: Update 6/29/2021:
New work implementing the title sort by Index title is to be implemented using Elasticsearch - MSEARCH-136 Closed In progress.

For Inventory then this will be implemented automatically when shifting the current search solution using PostgreSQL, JSONB columns, CQL and RAML Module Builder to be using Elastic Search - UXPROD-3046 Closed NFR: Inventory. Swap from search tool PostgreSQL to Elasticsearch

  • - - - - - - - - - - - - - - - -

Laura Daniels:
MM SMEs have expressed a desire, that is, to focus on the longer-term goals rather than interim goals if they can't be built on directly. The lack, for instance, of call number in the search results display of the holdings segment, would not be addressed by the improvements in the JIRA features listed below. So I agree with you, @charlotte, that putting resources toward the hierarchical display instead ( UXPROD-491 Analysis Complete ), if at all possible, is in our best interest.
Charlotte Whitt: See more comments added 2/23/2020 in UXPROD-491 Analysis Complete .
 

  • - - - - - - - - - - - - - - - -

This feature had original a wider scope, but is now narrowed to only include the work on use the Index titel, alternatively Resource title, in the display of the Result list - the library ranking is kept from the original feature, which previously included all relevant refinements of the result list for the MVP

The cap.plan team has asked for getting the different improvements split into their own feature:

  1. UXPROD-1634 (index title/title)
  2. UXPROD-2667 Open (sort on contributor, when more than one contributor is listed)
  3. UXPROD-2668 Open (Adding instance HRID)
  4. UXPROD-2669 Open (Adding resource type)
  5. UXPROD-2670 Draft (Adding format)
  6. UXPROD-2671 Open (Adding edition)
  7. UXPROD-2703 Draft (Adding publication date)

Overview: The result list has for the basic alpha implementation been: Resource title, and all listed contributors. With the refined use of elements implemented for beta, we need to configure the results in the Result list based on:

1) If there is an Index title, the title with no leading article, will display, and not the Resource title
2) If no Index title, the Resource title displays
3) After the Index title/Resource title, the primary contributor is displayed.

Notes:
This is critical for the results list display to be useful for any searches, displaying the title data of the instance record.

Usecase:
As a librarian who is searching in Inventory.
I want the search results to display the Index title (the title with no leading article), when available, instead of the Resource title.
So that I when having a large result list can avoid having screens after screens starting with display of titles starting with , A ..., The ..., etc.
See screen dump from Bugfest-Goldenrod, when searching on Keyword: water

Here is a default title sort:
https://bugfest-honeysuckle.folio.ebsco.com/inventory?qindex=querySearch&query=title%3D%3Ddave%20%2A&sort=titleNow change the `sort=title` part of the URL to `sort=indexTitle` and the title Dave moves all the way to the top:
https://bugfest-honeysuckle.folio.ebsco.com/inventory?qindex=querySearch&query=title%3D%3Ddave%20%2A&sort=indexTitle

 

Out of scope:

  1. Future need: customizable results lists

Documentation:

  1. Slide deck reviewed by MM-SIG 10/1/2020 and 10/8/2020 - https://docs.google.com/presentation/d/1kDumWwhNfP7Mq9hZ5q4O1cnbg_BY4ILgKbjBWOO4Xso/edit#slide=id.p
  2. Survey send out on the #metadata-management channel 10/7/2020 - https://docs.google.com/presentation/d/13Dt-Tkr_nzgU2Oxb044J4d3RSxxk4R-0lq-AlKXIItg/edit#slide=id.g9998cb799b_2_0


 Comments   
Comment by Cate Boerema (Inactive) [ 13/Jul/20 ]

Charlotte Whitt, can you please add a description of why this is feature is needed? For example:

As a librarian who is searching in Inventory
I want the search results to display the Index title (the title with no leading article), when available, instead of the Resource title
So that I can...

Also, I had a quick chat with Marc Johnson about this feature and it could be tricky. If we need to do this and we need to be able to search and sort by title, we will probably need to calculate an "effective title".

Comment by Charlotte Whitt [ 24/Jul/20 ]

I'll update the description. Please notice that this is a very core functionality, and an expected behavior of a bibliographic data base.

Comment by Christie Thomas [ 26/Aug/20 ]

Refinement of the display rules need to resolve the problem exemplified in this screen shot. There is not enough information available to be able to distinguish between the two instances.

Adding hrid, resource type, and format to the result lists would solve this issue.

Comment by Cate Boerema (Inactive) [ 03/Sep/20 ]

Adding hrid, resource type, and format to the result lists would solve this issue.

Thanks Christie Thomas. That seems like a different refinement to the ones described in this UXPROD. Charlotte Whitt, I think it would be better to be more specific in the UXPROD summary to clarify the kind of refinement that is in scope for this feature. Summaries like "Refined display rules" are multi-interpretable and people could be ranking this go-live with other refinements in mind.

3) After the Index title/Resource title, the primary contributor is displayed. If more contributors, the two next contributors. Max three. If more then an indication of: "(more)"
4) If no primary contributor is displayed, then the first three mentioned contributors
5) If no contributors, the result will only be the Index title/Resource title

Since the changes for the Title column (points #1 and #2) are probably going to necessitate the calculation of an "Effective title" and changing of Title sort functionality, I feel the points related to the Contributors column probably warrant a separate UXPROD feature. Also, on point #5, are you asking that the column not display if there are no contributors? I'm guessing you don't mean that so I think you could remove that point. Finally, for this Contributors column refinement, you might want to add some acceptance criteria around sorting. Do you want it to sort by the primary contributor, if there is one? It doesn't currently do that.

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt Cate Boerema

On Friday (2020-09-18), I was asked to estimate this feature.

There appears to be outstanding questions about the scope of this issue. Should the estimates include or exclude the contributor aspect of this?

What is the expected behaviour with sorting by title, should it always sort by resource title, or is it expected that the sorting will also respect this precedence between index title and resource title?

Comment by Charlotte Whitt [ 21/Sep/20 ]

Marc Johnson - your estimate should not include the contributor aspect. This is handles in a separate feature. Please see: UXPROD-2667 Open - this is explained in the top of the description.

All improvements of the result list are spec'ed in separate features. Does that makes sense?

  1. UXPROD-1634 Closed (index title/title)
  2. UXPROD-2667 Open (sort on contributor, when more than one contributor is listed)
  3. UXPROD-2668 Open (Adding instance HRID)
  4. UXPROD-2669 Open (Adding resource type)
  5. UXPROD-2670 Draft (Adding format)
  6. UXPROD-2671 Open (Adding edition)
Comment by Charlotte Whitt [ 21/Sep/20 ]

Re.

What is the expected behaviour with sorting by title, should it always sort by resource title, or is it expected that the sorting will also respect this precedence between index title and resource title?

The expected sorting is the list of titles as displayed in the result list - so it will be a combination:

  1. if the index title is available in the record and
  2. if only the resource title is available in the record
Comment by Marc Johnson [ 21/Sep/20 ]

Cate Boerema Charlotte Whitt

The keyword search uses the resource title at the moment (I believe), is the intention that the search behaviour changes to use this precedence as well?

Comment by Charlotte Whitt [ 21/Sep/20 ]

Marc Johnson - re.

The keyword search uses the resource title at the moment (I believe), is the intention that the search behaviour changes to use this precedence as well?

That's not needed.

Maybe it's necessary to explain the purpose of the Index title a little:
An index title IS the Resource title, but with the leading article being suppressed. The purpose is to get rid of 'noise' in the display - e.g. avoid thousands of records being listed with 'A ....' or 'An ....' or 'The ...' and many more depending on language. The index title - or rather where to begin the display of the resource title is part of the formatting of the title in the MARC record.

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt

That's not needed.

Does that mean that folks are ok with the title displayed in the search results being different to the title used to find the results when searching by title or keyword?

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt Thanks for the explanation.

An index title IS the Resource title, but with the leading article being suppressed. The purpose is to get rid of 'noise' in the display - e.g. avoid thousands of records being listed with 'A ....' or 'An ....' or 'The ...' and many more depending on language.

Both the name and the description lead me to think that variant of the title is better suited to searching, which is why I was slightly surprised that folks want searches to operate on the the resource title, and the index title to be presented.

Comment by Charlotte Whitt [ 21/Sep/20 ]

Yup - The Index title is only for display (certain alphabetic order) your titles in the library catalogue. That's why it's labeled Index title.

How to define the Index title is a library standard defined by AACR and local authorized cataloguing institutions.

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt

The Index title is only for display (certain alphabetic order) your titles in the library catalogue.

And for sorting?

Comment by Charlotte Whitt [ 21/Sep/20 ]

Marc Johnson - please just estimate the feature, as it states: Implement the Index title


Both the name and the description lead me to think that variant of the title is better suited to searching, which is why I was slightly surprised that folks want searches to operate on the the resource title, and the index title to be presented

Variant title - is a completely different ball came - and has nothing to do with display in the result list

Comment by Charlotte Whitt [ 21/Sep/20 ]

And for sorting?

Yup in the Result list

Comment by Charlotte Whitt [ 21/Sep/20 ]

Does that mean that folks are ok with the title displayed in the search results being different to the title used to find the results when searching by title or keyword?

Yes, that's correct.

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt

please just estimate the feature, as it states: Implement the Index title

Apologies, I need to understand a feature before I can estimate it :-/

Comment by Charlotte Whitt [ 21/Sep/20 ]

We can do a call Marc Johnson if that helps - then I can explain and do a little show and tell from the MARC format and the different types of title data defined in FOLIO Inventory - e.g. following list: https://folio-snapshot.dev.folio.org/settings/inventory/alternativeTitleTypes

Comment by Marc Johnson [ 21/Sep/20 ]

Charlotte Whitt

We can do a call if that helps - then I can explain and do a little show and tell from the MARC format and the different types of title data defined in FOLIO Inventory

Thanks for the offer. I am of course curious, however I am conscious that you have asked me to only estimate the work as it is described, which I believe I have done.

Comment by Cate Boerema (Inactive) [ 21/Sep/20 ]

Thanks for splitting this up, Charlotte Whitt. Did you intentionally carry-over the rankings from before? It seems like people may have different ideas on how this should be ranked since the scope has changed.

Comment by Charlotte Whitt [ 21/Sep/20 ]

Yes, I did intentionally carry over the rankings. To determine if a given title is the correct one, then you need the combination of data in the result list.
And what data to look at would vary for resource types - e.g. different if it's a monograph (her the editions for e.g. a given work by Franz Kafka would be very important, and for e.g. a journal then the HRID etc. etc.

So it makes little sense to ask the libraries IMHO to ranke each feature.

But if you disagree - I can delete, and we ask the libraries for more ranking ...

Comment by Cate Boerema (Inactive) [ 09/Oct/20 ]

Michal Kuklis can you please provide a FE estimate on this for us? Thanks!

Comment by Michal Kuklis [ 10/Oct/20 ]

Cate Boerema I just added it. It could be potentially "very small" if it's just the matter of setting correct order.

Comment by Charlotte Whitt [ 24/Feb/21 ]

Note to self: 

Change following line: https://github.com/folio-org/ui-inventory/blob/e0aca4480ecd1f203266297730cbc7977c2af854/src/filterConfig.js#L90 to:
{{

{ label: 'ui-inventory.title', value: 'title', queryTemplate: 'indexTitle all "%

{query.query}

"' },}}

 

or maybe:

Sorting here? https://github.com/folio-org/ui-inventory/blob/e0aca4480ecd1f203266297730cbc7977c2af854/src/filterConfig.js#L103
change to Title: 'indexTitle',

Comment by Charlotte Whitt [ 24/Feb/21 ]

Hi Michal Kuklis - when you wrote that this could potential be very small, were you then thinking about something like the above comment? 

This is something Simmons really want, and if it's a small change, and not at all BE work estimated for 10 days. Then maybe we could pull it in for R2 2021 Holly Mistlebauer?

Comment by Charlotte Whitt [ 25/Nov/21 ]

Manual test in Bugfest Kiwi. With the new work on UXPROD-3046 Closed swap Inventory Search from using postgreSQL to use Elasticsearch, and use sort by title - this feature is solved and implemented:

https://bugfest-kiwi.folio.ebsco.com/inventory/view/af7a25d5-a73e-4772-a020-be65fb5f4121?query=wolves&segment=instances&sort=title

 

I'll close the ticket as solved for Kiwi.

CC: Michal Kuklis Holly Mistlebauer

 

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