bd71a6d4107c67c2601bd6268212269242faba60
[working/Evergreen.git] / docs / RELEASE_NOTES_3_1.adoc
1 Evergreen 3_1 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Upgrade notes
7 -------------
8
9
10 New Features
11 ------------
12
13 Administration
14 ~~~~~~~~~~~~~~
15
16 New Latency Tester Tool
17 ^^^^^^^^^^^^^^^^^^^^^^^
18 The Evergreen Web Staff Client now includes a link to a section under
19 *Administration -> Workstation* called *Tests*. This page houses a simple tool
20 that can be used to test the latency of the websocket connection between the
21 client and the server (via the `opensrf.echo` service).
22
23 This page displays which Evergreen host server is being queried. Upon hitting
24 the blue "Start Test" button for the first time, it will issue 10 sequentially
25 fired requests in order to get a solid initial average. Clicking the button a
26 second time will just take one more measurement and recalculate the average
27 latency. The results can be copied to clipboard for troubleshooting purposes
28 and also cleared from display.
29
30 marc_export --uris option
31 ^^^^^^^^^^^^^^^^^^^^^^^^^
32 The marc_export support script now has a `--uris` option (short form:
33 `-u`) to export records with located URIs.  When used by itself, it will
34 export only records that have located URIs.  When used in conjunction
35 with `--items`, it will add records with located URIs but no
36 items/copies to the output.  If combined with a `--library` or
37 `--descendants` option, this option will limit its output to those
38 records with URIs at the designated libraries.  The best way to use
39 this option is in combination with the `--items` and one of the
40 `--library` or `--descendants` options to export *all* of a library's
41 holdings both real and electronic.
42
43
44 Architecture
45 ~~~~~~~~~~~~
46
47 Sample Data Includes Surveys
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49 The Concerto sample data set now includes patron surveys, questions,
50 answers, and responses.
51
52 Virtual Index Definitions
53 ^^^^^^^^^^^^^^^^^^^^^^^^^
54 The practical purpose of Virtual Index Definitions is to supply an Evergreen
55 administrator with the ability to control the weighting and field inclusion of
56 values in the general keyword index, commonly referred to as "the blob,"
57 without requiring tricky configuration that has subtle semantics, an
58 over-abundance of index definitions which can slow search generally, or the
59 need to reingest all records on a regular basis as experiments are performed
60 and the configuration refined. Significant results of recasting keyword indexes
61 as a set of one or more Virtual Index Definitions will be simpler search
62 configuration management, faster search speed overall, and more practical
63 reconfiguration and adjustment as needed.
64
65 Previous to this commit, in order to provide field-specific weighting to
66 keyword matches against titles or authors, an administrator must duplicate many
67 other index definitions and supply overriding weights to those duplicates. This
68 not only complicates configuration, but slows down record ingest as well as
69 search. It is also fairly ineffective at achieving the goal of weighted keyword
70 fields. Virtual Index Definitions will substantially alleviate the need for
71 these workarounds and their consequences.
72
73   * A Virtual Index Definition does not require any configuration for
74 extracting bibliographic data from records, but instead can become a sink for
75 data collected by other index definitions, which is then colocated together to
76 supply a search target made up of the separately extracted data. Virtual Index
77 Definitions are effectively treated as aggregate definitions, matching across
78 all values extracted from constituent non-virtual index definitions.  They can
79 further make use of the Combined class functionality to colocate all values in a
80 class together for matching even across virtual fields.
81
82   * Configuration allows for weighting of constituent index definitions that
83 participate in a Virtual Index Definition. This weighting is separate from the
84 weighting supplied when the index definition itself is a search target.
85
86   * The Evergreen QueryParser driver returns the list of fields actually
87 searched using every user-supplied term set, including constituent expansion
88 when a Virtual Index Definition is searched. In particular, this will facilitate
89 Search Term Highlighting described below.
90
91   * Stock configuration changes make use of pre-existing, non-virtual index
92 definitions mapped to new a Virtual Index Definition that implements the
93 functionality provided by the `keyword|keyword` index definition. The
94 `keyword|keyword` definition is left in place for the time being, until more data
95 can be gathered about the real-world effect of removing it entirely and
96 replacing it with Virtual Index Definition mappings.
97
98   * New system administration functions will be created to facilitate
99 modification of Virtual Index Definition mapping, avoiding the need for a full
100 reingest when existing index definitions are added or removed from a virtual
101 field.
102
103 Increased use of Metabib Display Fields
104 +++++++++++++++++++++++++++++++++++++++
105 We use Metabib Display Fields (newly available in 3.0) to render catalog search
106 results, intermediate metarecord results, and record detail pages. This requires
107 the addition of several new Metabib Display Field definitions, as well as Perl
108 services to gather and render the data.
109
110 We also use more Metabib Display Fields in the client. As a result,
111 bibliographic fields will display in proper case in more client interfaces and
112 in Evergreen reports.
113
114 Search Term Highlighting
115 ++++++++++++++++++++++++
116 This commit enables Search Term Highlighting in the OPAC on the main search
117 results page, the record detail page, and intermediate pages such as metarecord
118 grouped results page. Highlighting search terms will help the user determine why
119 a particular record (or set of records) was retrieved.
120
121 Highlighting of matched terms uses the same stemming used to accomplish the
122 search, as configured per field and class.
123
124 This feature will help the user more quickly determine the relevance of a
125 particular record by calling their attention to search terms in context. Lastly,
126 it will help familiarize the user with how records are searched, including which
127 fields are searched as well as exposing concepts like stemming.
128
129 Interfaces
130 ++++++++++
131 A new AngularJS "MARC Search/Facet Fields" interface has been created to replace
132 the Dojo version, and both have been extended to support Virtual Index
133 Definition data supplier mapping and weighting.
134
135 Settings & Permissions
136 ++++++++++++++++++++++
137 The new Virtual Index Definition data supplier mapping table,
138 `config.metabib_field_virtual_map`, requires the same permissions as the
139 MARC Search/Facet Fields interface: CREATE_METABIB_FIELD, UPDATE_METABIB_FIELD,
140 DELETE_METABIB_FIELD, or ADMIN_METABIB_FIELD for all actions
141
142 There is a new template-level global configuration variable in config.tt2 called
143 `search.no_highlight` which disables highlighting for users of that config.tt2
144 instance.
145
146 Public Catalog
147 ++++++++++++++
148 The public and staff catalog will make use of new APIs to identify and display
149 highlight-augmented values for those Display Fields used to render the search
150 result pages, intermediate metarecord constituent pages, and record detail
151 pages.  Highlighting of terms will be performed using the application of
152 Template::Toolkit-driven CSS. A generic CSS class identifying a highlighted
153 term, along with CSS classes identifying the search class and each search field
154 will be available for use for customization of the highlighting. A stock CSS
155 template is provided as a baseline upon which sites may expand.
156
157 When highlighting is generally enabled, it may be turned on or off on a per-page
158 basis through the use of a UI component which will request the page again
159 without highlighting.
160
161 Backend
162 +++++++
163 There now exist several new database tables and functions primarily in support
164 of search highlighting. Additionally, the QueryParser driver for Evergreen has
165 been augmented to be able to return a data structure describing how the search
166 was performed, in a way that allows a separate support API to gather a
167 highlighted version of the Display Field data for a given record.
168
169 Default Weights
170 +++++++++++++++
171 By default, the following fields will be weighted more heavily in keyword
172 searches. Administrators can change these defaults by changing the values in the
173  "All searchable fields" virtual index in the "MARC Search/Facet Fields"
174 interface.
175
176   * Title proper
177   * Main title (a new index limited to the words in the 245a)
178   * Personal author
179   * All subjects
180
181 In addition, note indexes and the physical description index will receive
182 less weight in default keyword searches.
183
184 Re-ingest or Indexing Dependencies
185 ++++++++++++++++++++++++++++++++++
186 With the addition and modification of many Index Definitions, a full reingest is
187 recommended.  However, search will continue to work as it did before the changes
188 in this commit for those records that have not yet been reingested during that
189 process.  Therefore a slow, rolling reingest is recommended.
190
191 Performance Implications or Concerns
192 ++++++++++++++++++++++++++++++++++++
193 Because the Metabib Display Fields infrastructure will eventually replace
194 functionality that is significantly more CPU-intensive in the various forms of
195 XML parsing, XSLT transformation, XPath calculation, and
196 Metabib Virtual Record construction, it is expected that the overall CPU load
197 will be reduced by this development, and ideally the overall time required to
198 perform and render a search will likewise drop. It is unlikely that the speed
199 increase will be visible to users on a per-search basis, but that search in
200 aggregate will become a smaller consumer of resources.
201
202
203 Cataloging
204 ~~~~~~~~~~
205
206 Track Record Merges
207 ^^^^^^^^^^^^^^^^^^^
208 When 2 or more bib records are merged, all records involved are stamped
209 with a new `merge_date` value.  For any bib record, this field indicates
210 the last time it was involved in a merge.  At the same time, all
211 subordinate records (i.e. those deleted as a product of the merge) are
212 stamped with a `merged_to` value indicating which bib record the source
213 record was merged with.
214
215 In the browser client bib record display, a warning alert now appears
216 along the top of the page (below the Deleted alert) indicating when a
217 record was used in a merge, when it was merged, and which record it was
218 merge with, rendered as a link to the target record.
219
220
221 Circulation
222 ~~~~~~~~~~~
223
224 Alternate Patron Hold Pickup
225 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
226 This feature adds a bit of convenience to a common task: checking out
227 an item on hold to another patron (typically a family member or helper).
228
229 When you checkout the item, you will get a pop-up window with warnings associated
230 with this item.  The "ITEM_ON_HOLDS_SHELF" message is now expanded to
231
232  * Let you know the name of the person who had placed the hold.
233  * Give you the option (in the form of a checkbox) of cancelling the
234    hold placed by the above-named patron.  (Checked = Cancel the hold;
235    Unchecked = Leave the hold in place)
236
237 The initial value of the checkbox is derived from the
238 `circ.clear_hold_on_checkout` organizational setting.
239
240 If the operator has CANCEL_HOLD privilege, then if the checkbox is checked and
241 the checkout is allowed to proceed, the hold will be cancelled with a note that
242 the item was checked out to another patron.
243
244 This feature is available in the browser-based staff client.
245
246 New Patron Billing Statement
247 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
248 The Evergreen web staff client now includes a patron billing statement,
249 which summarizes a patron's bills, credits and payments in a familiar
250 layout.  This can be found on the "Statement" tab of the Patron Bill
251 Details page. (From the Patron Bills page, double-click a row to view
252 its details, or choose "Full Details" from the Actions menu.)
253
254 Enhanced Billing Timestamp Support
255 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
256 Previously, billings had to make do with a single timestamp attempting
257 to fill two different roles.  In the case of an overdue fine, the
258 timestamp represented the *end* of the fine period for that billing,
259 while for all other fines, the timestamp was merely the time the bill
260 was created.  This setup generally worked, but not without confusion,
261 and limited our ability to understand and process the data.
262
263 Billings will now have up to three timestamps: a create date, and when
264 applicable, a fine period start and a fine period end.  This clarifies
265 and simplifies things like backdating, retrospective fine generation,
266 account balancing for negative balance avoidance, and billing timeline
267 views.
268
269 Copy Alerts and Suppression Matrix
270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
271 The Copy Alerts feature allows library staff to add customized alert
272 messages to copies. The copy alerts will appear when a specific event
273 takes place, such as when the copy is checked in, checked out, or
274 renewed. Alerts can be temporary or persistent: temporary alerts will be
275 disabled after the initial alert and acknowledgement from staff, while
276 persistent alerts will display each time the alert event takes place.
277 Copy Alerts can be configured to display at the circulating or owning
278 library only or, alternatively, when the library at which the alert
279 event takes place is not the circulating or owning library.  Copy Alerts
280 can also be configured to provide options for the next copy status that
281 should be applied to an item.  Library administrators will have the
282 ability to create and customize Copy Alert Types and to suppress copy
283 alerts at specific org units.
284
285 Copy alerts can be added via the volume/creator and the check in,
286 check out, and renew pages.  Copy alerts can also be managed at the
287 item status page.
288
289 Copy alert types can be managed via the Copy Alert Types page in
290 Local Administration, and suppression of them can be administered
291 via the Copy Alert Suppression page under Local Administration.
292
293 Place Multiple Holds At Once
294 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
295 Users with the appropriate permissions now have the ability to place multiple
296 title/metarecords holds at once. This feature is especially beneficial for book
297 clubs and reading groups, which need to place holds on multiple copies of a
298 title.
299
300 In order to use the feature:
301
302   * Set the _Maximum number of duplicate holds allowed_ Library Setting
303     (`circ.holds.max_duplicate_holds`) to a number higher than 1
304   * Log in as a user with the CREATE_DUPLICATE_HOLDS
305
306 When placing a title or metarecord hold, a _Number of copies_ field will
307 display for these users. This field is not available when placing part, volume
308 or copy holds.
309
310 This feature does not change the way in which the system fills holds. The
311 multiple holds will fill in the same way that they would if the user had placed
312 multiple holds separately.
313
314 New Notice Columns in Items Out Grid
315 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316 The grid in the patron "items out" page in the Evergreen web staff client has two new
317 columns indicating the number of notifications generated for a given loan and the date of
318 the most recent notification. These columns will allow circulation staff to better respond to
319 patron questions about whether they were sent notification about an overdue item.
320
321 The columns are based on the number of completed Action Trigger events on the
322 loan that have a 'checkout.due' hook. In other words, they would include overdue
323 and courtesy notices.
324
325 A new library setting, "Exclude Courtesy Notices from Patrons Itemsout Notices Count",
326 if set will cause the notice count and date fields to exclude courtesy notices.
327
328 Patron Email Addresses Now Clickable In Web Staff Client
329 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
330 Adds a mailto link to the patron's email in their profile so it can
331 be clicked to send and email to the patron. No new settings or
332 permissions are included in this feature.
333
334
335 OPAC
336 ~~~~
337
338 Copy Location Filter Displays for System Searches
339 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
340 The Shelving Location filter now displays on the advanced search page when
341 a search is scoped to a library system, not just to an individual branch. If
342 a library system is selected as the Search Library, the shelving location
343 limiter will display any shelving location that is owned by the selected system
344 or by the consortium. It will NOT display shelving locations owned by child
345 branches.
346
347 Multi-source Attributes
348 ^^^^^^^^^^^^^^^^^^^^^^^
349 We now allow record attribute definitions to extract data using more than
350 one strategy (XPath, tag+subfield, fixed field, etc.) as long as the values
351 from various sources would, after normalization, have the same shape.
352
353 Multilingual Search
354 +++++++++++++++++++
355 This change allows us to configure multilingual search, by extracting values
356 from both the 008 controlfield and the 041 datafield.  Because the values
357 in each can be normalized to the same controlled list (and, in practice, are
358 already from the same normalized value set), OPAC searches can now use normal
359 boolean search semantics to find records with various combinations of
360 language attributes.
361
362 E.g., in the concerto test data:
363
364   * `keyword: piano item_lang(eng) item_lang(ita)`
365
366
367 Optional Display of Badges in OPAC
368 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
369 A new setting controls whether badges (popularity, etc.) are displayed
370 in the OPAC. If you do not wish badges to be displayed, set the
371 `ctx.hide_badge_scores` setting to "true" in `config.tt2`.
372
373
374 Miscellaneous
375 -------------
376
377 Fixes to patron name/username search indexes
378 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379 When using pg_restore to restore an Evergreen database, some of the
380 indexes used to speed up patron searches on names and usernames
381 could be lost.
382
383 This release fixes the underlying issue and re-creates the indexes
384 in question.
385
386 Details
387 ^^^^^^^
388 When using pg_restore to restore an affected database, the
389 "unaccent" indexes on actor.usr would not be created due to an
390 unqualified function reference in `evergreen.unaccent_and_squash`.
391
392 The function will be replaced to resolve the search path issue,
393 and the following indexes on actor.usr will be dropped and then
394 re-created:
395
396   * actor_usr_first_given_name_unaccent_idx;
397   * actor_usr_second_given_name_unaccent_idx;
398   * actor_usr_family_name_unaccent_idx;
399   * actor_usr_usrname_unaccent_idx;
400
401 This will be done even if the indexes are already present, and may
402 take a few minutes on a database with many patrons.
403
404
405 Acknowledgments
406 ---------------
407 The Evergreen project would like to acknowledge the following
408 organizations that commissioned developments in this release of
409 Evergreen:
410
411 * Albany Public Library (Oregon)
412 * C/W MARS
413 * Evergreen Indiana
414 * Linn-Benton Community College
415 * MassLNC
416 * PaILS
417 * Sage Library System
418
419 We would also like to thank the following individuals who contributed
420 code, translations, documentations patches and tests to this release of
421 Evergreen:
422
423 TODO
424
425
426 We also thank the following organizations whose employees contributed
427 patches:
428
429 TODO
430
431 We regret any omissions.  If a contributor has been inadvertently
432 missed, please open a bug at http://bugs.launchpad.net/evergreen/
433 with a correction.