docs/RELEASE_NOTES_NEXT/OPAC/popularity-rating.txt

   1 Popularity Boost for Ranking Search Results
   2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   3
   4 This feature uses factors such as  circulation and hold activity, record and item age, and item ownership counts to generate popularity badges for bibliographic
   5 records. Each badge will have a five-point scale, where more points indicates a more popular record.  The average of the badge points earned by each record will constitute a "popularity rating". The number and types of badges will break ties for average popularity, and relevance will sort items with like popularity.
   6
   7 A new sort axis of popularity is created to sort first on the weighted average popularity of each record, followed by the query-specific relevance available today.  A new option is created in the dropdown called _Most Popular_ that sorts on the combination of "activity metric" (aka badge ranking, aka popularity) first and then the existing, stock relevance ranking when those are equal.  For instance, given two records that both have a badge ranking of "4.5", they sort in the order of the query relevance ranking that is calculated today as a tie breaker.  Those two records will sort above other records with lower badge rankings regardless of what today's relevance ranking says about them.
   8
   9 In addition, a new sort axis of _Popularity-Adjusted Relevance_ is created that augments the normal Relevance sort with a normalized popularity value by multiplying the base relevance by a value controlled by a new global flag, generally set to a decimal number between 1 and 2.
  10
  11 Finally, there will continue to be a pure _Relevance_ sort option, which is the version that exists today.
  12
  13 Administrators can comment out one of the available sort methods by editing the
  14 filtersort.tt2 file.A global flag will allow Evergreen sites to select a default sort method.
  15
  16 Badge Configuration
  17 ^^^^^^^^^^^^^^^^^^^
  18
  19 Administrative interfaces to configure badges are only available in the web
  20 client. Administrators can also configure badges directly via the database.
  21
  22 Available Popluarity Parameters available for badges include:
  23
  24 * Holds Filled Over Time
  25 * Holds Requested Over Time
  26 * Current Hold Count
  27 * Circulations Over Time
  28 * Current Circulation Count
  29 * Out/Total Ratio
  30 * Holds/Total Ratio
  31 * Holds/Holdable Ratio
  32 * Percent of Time Circulating
  33 * Bibliographic Record Age (days)
  34 * Publication Age (days)
  35 * Available On-Line (for e-books, etc)
  36 * Copy Count
  37
  38 Badges can be configured to apply to a targeted group of bibliographic records
  39 based on the following available filters:
  40
  41 * Record attribute
  42 * Bibliographic source
  43 * Circulation modifier
  44 * Copy location group
  45
  46 Badges can also be be restricted to materials owned by a specific organiztional
  47 unit.
  48
  49 This new feature comes with a starter badge based on the top 97th percentile of
  50 holds requested over the past five years.
  51
  52 Display in the OPAC
  53 +++++++++++++++++++
  54
  55 Ratings for records will be displayed in the catalog in the following ways:
  56
  57 * On the record result page, the overall average popularity rating is displayed with a label of _Popularity_.
  58
  59 * On the record detail page, each individual badge earned by the record is
  60 displayed with its rating.
  61
  62 New Global Flags
  63 ++++++++++++++++
  64 * **OPAC Default Sort (opac.default_sort)**: Identifies the default sort method
  65 to be used in the catlaog.
  66
  67 * **Maximum popularity importance multiplier for popularity-adjusted relevance
  68 searches (search.max_popularity_importance_multiplier):** A multiplier identifying
  69 the importance of popularity in the Popularity-Adjusted Relevance ranked
  70 searches. The number should be a decimal ranging between 1.0 and 2.0. The
  71 default value is 1.1.
  72
  73 More detailed information is available TechRef docs directory in the
  74 Evergreen source code.