]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/RELEASE_NOTES_3_7.adoc
docs: release notes 3.7.2
[Evergreen.git] / docs / RELEASE_NOTES_3_7.adoc
1 = Evergreen 3.7 Release Notes =
2 :toc:
3 :numbered:
4
5 == Evergreen 3.7.2 ==
6
7 This release contains bug fixes improving on Evergreen 3.7.1.
8
9 === Upgrade notes ===
10
11 In reference for the fix to bug (https://bugs.launchpad.net/evergreen/+bug/1944765[LP1944765]), existing Evergreen systems on Debian and Ubuntu should do the following to ensure that mod_headers is active:
12
13 `sudo a2enmod headers`
14 `sudo systemctl restart apache2`
15
16 === Bug Fixes ===
17
18 ==== Acquisitions ====
19
20 * Fixes column header in Line Item Search (https://bugs.launchpad.net/evergreen/+bug/1906826[LP1906826])
21
22 ==== Administration ====
23
24 * Adds automated tests for ISBN-13 starting with 979 (https://bugs.launchpad.net/evergreen/+bug/1857060[LP1857060])
25 * Adds circ.collections.exempt user setting to seed data (https://bugs.launchpad.net/evergreen/+bug/1937299[LP1937299])
26 * Adds CPAN module prerequisites for the 'Did You Mean' search suggestions feature (https://bugs.launchpad.net/evergreen/+bug/1936662[LP1936662])
27 * Adds Library Setting to 'Did You Mean' baseline (https://bugs.launchpad.net/evergreen/+bug/1931167[LP1931167])
28 * Restricts access to library setting history for unauthorized users (https://bugs.launchpad.net/evergreen/+bug/1450519[LP1450519])
29 * Fixes filter errors on secondary admin pages (https://bugs.launchpad.net/evergreen/+bug/1919483[LP1919483])
30 * Fixes an issue with the Default Net Access Level Library Setting (https://bugs.launchpad.net/evergreen/+bug/1802682[LP1802682])
31 * Additional query optimization for 'Did You Mean' (https://bugs.launchpad.net/evergreen/+bug/1931162[LP1931162])
32 * Fixes an issue with Action Triggers that have a repeat delay (https://bugs.launchpad.net/evergreen/+bug/1823983[LP1823983])
33 * Fixes an issue with the Action Trigger ApplyPatronPenalty reactor (https://bugs.launchpad.net/evergreen/+bug/1859502[LP1859502])
34 * Enables Apache module mod_headers by default (https://bugs.launchpad.net/evergreen/+bug/1944765[LP1944765])
35 * Fixes typo in three Library Settings descriptions https://bugs.launchpad.net/evergreen/+bug/1826759[LP1826759])
36
37 ==== API ====
38
39 ==== Architecture ====
40
41 * Fixes datatype issues that can cause unexpected behavior (https://bugs.launchpad.net/evergreen/+bug/1923076[LP1923076])
42 * Fixes an issue running "npm install" for the Angular JS web client (https://bugs.launchpad.net/evergreen/+bug/1937875[LP1937875])
43 * Fixes typo in pingest.pl help command (https://bugs.launchpad.net/evergreen/+bug/1924562[LP1924562])
44
45 ==== Booking ====
46
47 * Adds new Booking permissions to appropriate Permission Groups (https://bugs.launchpad.net/evergreen/+bug/1910891[LP1910891])
48 * Fixes an issue where Booking Resource Type box was not populating (https://bugs.launchpad.net/evergreen/+bug/1916949[LP1916949])
49
50 ==== Catalog ==== 
51
52 * Adds "Show more details" button & workstation setting for the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1908722[LP1908722])
53 * Adds call number display Staff Catalog search results (https://bugs.launchpad.net/evergreen/+bug/1910808[LP1910808])
54 * Restores preferred library holdings count in search results (https://bugs.launchpad.net/evergreen/+bug/1913807[LP1913807])
55 * Fixes duplicate circ mod display in embedded OPAC view (https://bugs.launchpad.net/evergreen/+bug/1930308[LP1930308])
56 * Adds jump to details on one hit support to the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1912852[LP1912852])
57 * Adds a Patron View button to the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1910452[LP1910452])
58 * Fixes display of Age Hold Protection in the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1908614[LP1908614])
59 * Adds OPAC visible to Holdings View in the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1917338[LP1917338])
60 * Fixes 'copy queue to bucket' function in Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1928275[LP1929275])
61 * Fixes an issue where the holds page would refresh before a batch holds cancel was complete (https://bugs.launchpad.net/evergreen/+bug/1911023[LP1911023])
62 * Fixes an issue where 'submit' or 'enter' was required for a patron barcode on the Staff Catalog holds form (https://bugs.launchpad.net/evergreen/+bug/1903358[LP1903358])
63
64
65 ==== Cataloging ====
66
67 * Adds a workstation setting to allow users to save grid preferences for the angular catalog item table (https://bugs.launchpad.net/evergreen/+bug/1907296[LP1907296])
68 * Adds SRCE fixed field to Angular MARC Editor (https://bugs.launchpad.net/evergreen/+bug/1718782[LP1718782])
69 * Fixes the Delete Queue link on the Queue Details Page in MARC Batch Import/Export (https://bugs.launchpad.net/evergreen/+bug/1934184[LP1934184])
70 * Fixes a text error in the Load Shared Bucket modals (https://bugs.launchpad.net/evergreen/+bug/1929839[LP1929839])
71 * Fixes an issue that allows precat merges (https://bugs.launchpad.net/evergreen/+bug/827356[LP827356])
72 * Fixes a TCN/ID mismatch in the z39.50 interface (https://bugs.launchpad.net/evergreen/+bug/1786971[LP1786971])
73 * Fixes an issue where import operations could fail (https://bugs.launchpad.net/evergreen/+bug/1941764[LP1941764])
74 * Fixes an issue where authority records with long subfields would not load (https://bugs.launchpad.net/evergreen/+bug/1922567[LP1922567])
75
76 ==== Circulation ====
77
78 * Fixes excess pcrud calls in barcode lookup (https://bugs.launchpad.net/evergreen/+bug/1929136[LP1929136])
79 * Fixes an issue where batch checkin from Item Status caused rapid-fire popups (https://bugs.launchpad.net/evergreen/+bug/1742553[LP1742553])
80 * Fixes an issue where self-check audio alerts were failing (https://bugs.launchpad.net/evergreen/+bug/1815968[LP1815968])
81 * Fixes an issue where removing patrons from buckets caused too many simultaneous requests (https://bugs.launchpad.net/evergreen/+bug/1932358[LP1932358])
82 * Adds missing patron data to Holds for Patron print template (https://bugs.launchpad.net/evergreen/+bug/1926971[LP1926971])
83 * Fixes incorrect hints for fields in the Checkout print template (https://bugs.launchpad.net/evergreen/+bug/1901028[LP1901028])
84 * Fixes a timezone issue with staff scheduled Curbside appointments (https://bugs.launchpad.net/evergreen/+bug/1917396[LP1917396])
85 * Fixes an issue where the Missing Pieces slip was sent to the Default printer instead of the Receipt printer (https://bugs.launchpad.net/evergreen/+bug/1938450[LP1938450])
86 * Fixes excess openils.actor calls in Add to Item Bucket (https://bugs.launchpad.net/evergreen/+bug/1932051[LP1932051])
87 * Fixes sorting of SMS Carriers when editing an existing hold (https://bugs.launchpad.net/evergreen/+bug/1809157[LP1809157])
88 * Fixes messages in the patron Offline Block List (https://bugs.launchpad.net/evergreen/+bug/1752356[LP1752356])
89 * Fixes an issue where cloned patron addresses were set to Pending (https://bugs.launchpad.net/evergreen/+bug/1821804[LP1821804])
90 * Fixes an issue with retargeting when a hold's pickup library is changed (https://bugs.launchpad.net/evergreen/+bug/1866667[LP1866667])
91 * Fixes an issue that allowed Hold Activation Dates in the past in the Staff Catalog (https://bugs.launchpad.net/evergreen/+bug/1903357[LP1903357])
92 * Fixes patron name display to use preferred name in the Staff Catalog Place Hold screen (https://bugs.launchpad.net/evergreen/+bug/1924621[LP1924621])
93 * Fixes display of legacy circulations in circ summary (https://bugs.launchpad.net/evergreen/+bug/1942920[LP1942920])
94
95
96 ==== Client ====
97
98 * Fixes display issue in Angular grids (https://bugs.launchpad.net/evergreen/+bug/1916754[LP1916754])
99 * Restores the Circulation History by Year information in Item Status (https://bugs.launchpad.net/evergreen/+bug/1743611[LP1743611]) 
100 * Fixes a display issue with formerly precataloged items (https://bugs.launchpad.net/evergreen/+bug/1904754[LP1904754])
101 * Fixes an issue that allowed logins by expired accounts (https://bugs.launchpad.net/evergreen/+bug/1844121[LP1844121])
102 * Adds missing workstation types for Carousels (https://bugs.launchpad.net/evergreen/+bug/1920253[LP1920253])
103 * Adds caching for workstation & user settings values (https://bugs.launchpad.net/evergreen/+bug/1938729[LP1939729])
104
105 ==== Course Materials ====
106
107 * Fixes an issue where a blank course section number impacted OPAC display (https://bugs.launchpad.net/evergreen/+bug/1913221[LP1913221])
108 * Adds circulation modifier to OPAC Course Details page (https://bugs.launchpad.net/evergreen/+bug/1935693[LP1935693])
109 * Adds an Org Unit selector to the Course List (https://bugs.launchpad.net/evergreen/+bug/1905068[LP1905068])
110 * Fixes the owning library default when adding a new course (https://bugs.launchpad.net/evergreen/+bug/1917809[LP1917809])
111 * Fixes an issue that allowed unreasonable Course-Term mappings (https://bugs.launchpad.net/evergreen/+bug/1906058[LP1906058])
112
113 ==== OPAC ====
114
115 * Fixes alignment issue on mobile devices (https://bugs.launchpad.net/evergreen/+bug/1928005[LP1928005])
116 * Adds Curbside Appointments to Bootstrap OPAC (https://bugs.launchpad.net/evergreen/+bug/1895737[LP1895737])
117 * Adds 'Limit to Available' in Bootstrap OPAC copy table (https://bugs.launchpad.net/evergreen/+bug/1908612[LP1908612])
118 * Fixes an issue where the Login box was not translateable (https://bugs.launchpad.net/evergreen/+bug/1919497[LP1919497])
119 * Fixes alignment issue with available and holds copy counts in the Bootstrap OPAC (https://bugs.launchpad.net/evergreen/+bug/1933125[LP1933125])
120 * Makes the Bootstrap OPAC self registration form more responsive (https://bugs.launchpad.net/evergreen/+bug/1920273[LP1920273])
121 * Adds missing title and descripton for Shared Lists in the Bootstrap OPAC (https://bugs.launchpad.net/evergreen/+bug/1909584[LP1909584])
122 * Fixes hold failures due to SMS notification selection errors (https://bugs.launchpad.net/evergreen/+bug/1933381[LP1933381])
123 * Fixes tabbing & focus in Bootstrap OPAC login form 
124 (https://bugs.launchpad.net/evergreen/+bug/1909144[LP1909144])
125 * Replaces javascript onfocus/onblur with HTML5 placeholder in KPAC (https://bugs.launchpad.net/evergreen/+bug/1834258[LP1834258])
126
127 ==== Reports ====
128
129 ==== Serials ====
130
131 ==== SIP ====
132
133 * Exports PERL5LIB in oils_ctl.sh to account for a change in Perl 5.26.0. This change affects Ubuntu 18.04 (Bionic Beaver) and Debian 10 (Buster) and any future releases. (https://bugs.launchpad.net/evergreen/+bug/1899974[LP1899974])
134
135 === Acknowledgements ===
136
137 We would like to thank the following individuals who contributed code,
138 testing and documentation patches to the 3.7.2 point release of Evergreen:
139
140 * John Amundson
141 * Adam Bowling
142 * Jason Boyer
143 * Dan Briem
144 * Christine Burns
145 * Eva Cerninakova
146 * Galen Charlton
147 * Garry Collum
148 * Dawn Dale
149 * Jeff Davis
150 * Bill Erickson
151 * Jason Etheridge
152 * Ruth Frasur
153 * Rogan Hamby
154 * Elaine Hardy
155 * Shula Link
156 * Tiffany Little
157 * Mary Llewellyn
158 * Terran McCanna
159 * Gina Monti
160 * Christine Morgan
161 * Michele Morgan
162 * Andrea Buntz Neiman
163 * Jennifer Pringle
164 * Mike Risher
165 * Erica Rohlfs
166 * Mike Rylander
167 * Jane Sandberg
168 * Chris Sharp
169 * Jason Stephenson
170 * Josh Stompro
171 * Jennifer Weston
172 * Beth Willis
173 * Jessica Woolford
174
175
176
177
178 == Evergreen  3.7.1 ==
179
180 This release contains bug fixes improving on Evergreen 3.7.0.
181
182
183 === Bug Fixes ===
184
185 ==== Acquisitions ====
186
187 * Acq PO Search cancel reason column shows description (https://bugs.launchpad.net/bugs/1906825[Bug 1906825])
188 * Date columns in Acq Search now also show time (https://bugs.launchpad.net/bugs/1912097[Bug 1912097])
189
190 ==== Administration ====
191
192 * Fixes an issue with editing carousels (https://bugs.launchpad.net/bugs/1879769[Bug 1879769])
193 * Carousel admin grid now has a link to edit the relevant bucket (https://bugs.launchpad.net/bugs/1901893[Bug 1901893])
194 * The Active Column in SMS Carrier administration now displays properly (https://bugs.launchpad.net/bugs/1873539[Bug 1873539])
195 * Fixes upgrade script for Enhanced Print/Email (https://bugs.launchpad.net/bugs/1905091[Bug 1905091])
196 * Cleans up numerous Perl warnings in logs (https://bugs.launchpad.net/bugs/1895660[Bug 1895660])
197
198
199 ==== Catalog ====
200
201 * Fixes an issue displaying highlighting in traditional and bootstrap catalogue (https://bugs.launchpad.net/bugs/1923225[Bug 1923225])
202 * Fixes an issue displaying works with the word "hidden" in the title (https://bugs.launchpad.net/bugs/1930933[Bug 1930933])
203 * Bootstrap OPAC: Simple Selector for Lang now works in Advanced Search (https://bugs.launchpad.net/bugs/1920042[Bug 1920042])
204 * Bootstrap OPAC: My account summary now displays ebook references according to config file (https://bugs.launchpad.net/bugs/1910288[Bug 1910288])
205 * Bootstrap OPAC: Item tags no longer display as separate copies on an x-small screen (https://bugs.launchpad.net/bugs/1916936[Bug 1916936])
206 * Fixes nesting issues on the Bootstrap OPAC Record Detail Page (https://bugs.launchpad.net/bugs/1901710[Bug 1901710])
207 * Opac SMS and Carrier Fields display according to OU Setting when Editing a Hold (https://bugs.launchpad.net/bugs/1902302[Bug 1902302])
208 * Better controls for collapsing and expanding the staff catalog search form (https://bugs.launchpad.net/bugs/1913338[Bug 1913338])
209
210 ==== Cataloging ====
211
212 * Angular Catalog: "Edit" link no longer ignores UPDATE_COPY perm (https://bugs.launchpad.net/bugs/1920815[Bug 1920815])
213 * Angular catalog: fixes an issue with metarecord search (https://bugs.launchpad.net/bugs/1930088[Bug 1930088])
214 * Angular staff catalog now displays e-resource links (https://bugs.launchpad.net/bugs/1881607[Bug 1881607])
215 * Record bucket Batch Edit now navigates to the Angular batch editor (https://bugs.launchpad.net/bugs/1926310[Bug 1926310])
216 * Angular Catalog: Shelving locations assigned to the top level OU now display in list (https://bugs.launchpad.net/bugs/1927527[Bug 1927527])
217 * Add to Carousel added back to the Other Actions menu in the Bib Record (https://bugs.launchpad.net/bugs/1922120[Bug 1922120])
218 * Makes terminology more consistent in Angular Catalog (https://bugs.launchpad.net/bugs/1925725[Bug 1925725])
219
220
221 ==== Circulation ====
222
223 * Preferred Name is now the prominent display name (https://bugs.launchpad.net/bugs/1924185[Bug 1924185])
224 * Unchanged workstation settings are no longer re-applied on every checkin (https://bugs.launchpad.net/bugs/1918362[Bug 1918362])
225 * Adds accessible field labels in patron search and edit (https://bugs.launchpad.net/bugs/1615800[Bug 1615800])
226 * Fixes an issue with the embedded "Place a hold" catalog in the checkout interface (https://bugs.launchpad.net/bugs/1887876[Bug 1887876])
227 * Angular Catalog: Hold status in View Holds is now saved (https://bugs.launchpad.net/bugs/1917495[Bug 1917495])
228 * Angular Staff Catalog: Hold Pickup Library no longer sometimes empty (https://bugs.launchpad.net/bugs/1917944[Bug 1917944])
229 * Fixes an issue with the Angular catalog view holds sort by patron barcode (https://bugs.launchpad.net/bugs/1928684[Bug 1928684])
230 * Staff catalog hold detail page now supports hold notes/notifications (https://bugs.launchpad.net/bugs/1910145[Bug 1910145])
231
232 ==== Client ====
233
234 * Angular grid column field picker has a better sort order (https://bugs.launchpad.net/bugs/1891699[Bug 1891699])
235 * Angular grids now support shift-click multi-row selection (https://bugs.launchpad.net/bugs/1911238[Bug 1911238])
236 * Fixes an issue with multi-word queries in the splash page catalog search (https://bugs.launchpad.net/bugs/1892435[Bug 1892435])
237
238 ==== Database ====
239
240 * Evergreen now uses the builtin array_remove() function rather than its own custom version (https://bugs.launchpad.net/bugs/1778955[Bug 1778955])
241 * Adds seed data for the eg.orgselect.hopeless.wide_holds setting (https://bugs.launchpad.net/bugs/1895738[Bug 1895738])
242
243
244 ==== Documentation ====
245
246 * Adds documentation on how to contribute Documentation (https://bugs.launchpad.net/bugs/1927534[Bug 1927534])
247 * Adds IDL acronym to the glossary (https://bugs.launchpad.net/bugs/1857917[Bug 1857917])
248 * Adds documentation on how to use the browser client efficiently (https://bugs.launchpad.net/bugs/1250528[Bug 1250528] and https://bugs.launchpad.net/bugs/1751146[Bug 1751146])
249 * Improves example for LDAP authentication (https://bugs.launchpad.net/bugs/1901940[Bug 1901940])
250 * Adds documentation about patron with negative balances (https://bugs.launchpad.net/bugs/1929467[Bug 1929467])
251
252 === Acknowledgements ===
253
254 We would like to thank the following individuals who contributed code,
255 testing and documentation patches to the 3.7.1 point release of Evergreen:
256
257
258 * Jason Boyer
259 * Dan Briem
260 * Galen Charlton
261 * Garry Collum
262 * Jeff Davis
263 * Bill Erickson
264 * Jason Etheridge
265 * Lynn Floyd
266 * Blake Graham Henderson
267 * Rogan Hamby
268 * Elaine Hardy
269 * Kyle Huckins
270 * Rosie Le Faive
271 * Tiffany Little
272 * Mary Llewellyn
273 * Katie G. Martin
274 * Terran McCanna
275 * Gina Monti
276 * Michele Morgan
277 * Andrea Buntz Neiman
278 * Mike Risher
279 * Mike Rylander
280 * Jane Sandberg
281 * Chris Sharp
282 * Chrisy Schroth
283 * Jason Stephenson
284 * Stephen Wills
285
286 == Evergreen  3.7.0 ==
287
288 === Upgrade notes ===
289
290 ==== Database Upgrade Procedure ====
291
292 The database schema upgrade for Evergreen 3.7 has more steps than normal. The general
293 procedure, assuming Evergreen 3.6.2 as the starting point, is:
294
295 . Run the main 3.6.2 => to 3.7 schema update script from the Evergreen source directory,
296 supplying database connection parameters as needed:
297 +
298 [source,sh]
299 ----
300 psql -f Open-ILS/src/sql/Pg/version-upgrade/3.6.2-3.7.0-upgrade-db.sql 2>&1 | tee 3.6.2-3.7.0-upgrade-db.log
301 ----
302 [start=2]
303 . Create and ingest search suggestions:
304 .. Run the following from `psql` to export the strings to files:
305 +
306 [source,sql]
307 ----
308 \a
309 \t
310
311 \o title
312 select value from metabib.title_field_entry;
313 \o author
314 select value from metabib.author_field_entry;
315 \o subject
316 select value from metabib.subject_field_entry;
317 \o series
318 select value from metabib.series_field_entry;
319 \o identifier 
320 select value from metabib.identifier_field_entry;
321 \o keyword
322 select value from metabib.keyword_field_entry;
323
324 \o
325 \a
326 \t
327 ----
328 [start=2]
329 .. From the command line, convert the exported words into SQL scripts to load into the database.
330 This step assumes that you are at the top of the Evergreen source tree.
331 +
332 [source,sh]
333 ----
334 $ ./Open-ILS/src/support-scripts/symspell-sideload.pl title > title.sql
335 $ ./Open-ILS/src/support-scripts/symspell-sideload.pl author > author.sql
336 $ ./Open-ILS/src/support-scripts/symspell-sideload.pl subject > subject.sql
337 $ ./Open-ILS/src/support-scripts/symspell-sideload.pl series > series.sql
338 $ ,/Open-ILS/src/support-scripts/symspell-sideload.pl identifier > identifier.sql
339 $ ./Open-ILS/src/support-scripts/symspell-sideload.pl keyword > keyword.sql
340 ----
341 [start=3]
342 .. Back in `psql`, import the suggestions. This step can take several hours in a large databases,
343 but the `\i $FILE.sql`` steps can be run in parallel.
344 +
345 [source,sql]
346 ----
347 ALTER TABLE search.symspell_dictionary SET UNLOGGED;
348 TRUNCATE search.symspell_dictionary;
349
350 \i identifier.sql
351 \i author.sql
352 \i title.sql
353 \i subject.sql
354 \i series.sql
355 \i keyword.sql
356
357 CLUSTER search.symspell_dictionary USING symspell_dictionary_pkey;
358 REINDEX TABLE search.symspell_dictionary;
359 ALTER TABLE search.symspell_dictionary SET LOGGED;
360 VACUUM ANALYZE search.symspell_dictionary;
361
362 DROP TABLE search.symspell_dictionary_partial_title;
363 DROP TABLE search.symspell_dictionary_partial_author;
364 DROP TABLE search.symspell_dictionary_partial_subject;
365 DROP TABLE search.symspell_dictionary_partial_series;
366 DROP TABLE search.symspell_dictionary_partial_identifier;
367 DROP TABLE search.symspell_dictionary_partial_keyword;
368 ----
369 [start=3]
370 . (optional) Apply the new opt-in setting for overdue and preduce notices.
371 The following query will set the circ.default_overdue_notices_enabled
372 user setting to true (the default value) for all existing users,
373 ensuring they continue to receive overdue/predue emails.
374 +
375 [source,sql]
376 ----
377 INSERT INTO actor.usr_setting (usr, name, value)
378 SELECT
379 id,
380 circ.default_overdue_notices_enabled,
381 true
382 FROM actor.usr;
383 ----
384 +
385 The following query will add the circ.default_overdue_notices_enabled
386 user setting as an opt-in setting for all action triggers that send
387 emails based on a circ being due (unless another opt-in setting is
388 already in use).
389 +
390 [source,sql]
391 ----
392 UPDATE action_trigger.event_definition
393 SET opt_in_setting = circ.default_overdue_notices_enabled,
394 usr_field = usr
395 WHERE opt_in_setting IS NULL
396 AND hook = checkout.due
397 AND reactor = SendEmail;
398 ----
399 Evergreen admins who wish to use the new setting should run both of
400 the above queries. Admins who do not wish to use it, or who are
401 already using a custom opt-in setting of their own, do not need to
402 do anything.
403 [start=4]
404 . Perform a `VACUUM ANALYZE` of the following tables using `psql`:
405 +
406 [source,sql]
407 ----
408 VACUUM ANALYZE authority.full_rec;
409 VACUUM ANALYZE authority.simple_heading;
410 VACUUM ANALYZE metabib.identifier_field_entry;
411 VACUUM ANALYZE metabib.combined_identifier_field_entry;
412 VACUUM ANALYZE metabib.title_field_entry;
413 VACUUM ANALYZE metabib.combined_title_field_entry;
414 VACUUM ANALYZE metabib.author_field_entry;
415 VACUUM ANALYZE metabib.combined_author_field_entry;
416 VACUUM ANALYZE metabib.subject_field_entry;
417 VACUUM ANALYZE metabib.combined_subject_field_entry;
418 VACUUM ANALYZE metabib.keyword_field_entry;
419 VACUUM ANALYZE metabib.combined_keyword_field_entry;
420 VACUUM ANALYZE metabib.series_field_entry;
421 VACUUM ANALYZE metabib.combined_series_field_entry;
422 VACUUM ANALYZE metabib.real_full_rec;
423 ----
424
425 ==== New Seed Data ====
426
427
428 ===== New Permissions =====
429
430 * Administer geographic location services (`ADMIN_GEOLOCATION_SERVICES`)
431 * Administer library groups (`ADMIN_LIBRARY_GROUPS`)
432 * Manage batch (subscription) hold events (`MANAGE_HOLD_GROUPS`)
433 * Modify patron SSO settings (`SSO_ADMIN`)
434 * View geographic location services (`VIEW_GEOLOCATION_SERVICES`)
435
436 ===== New Global Flags =====
437
438 * Block the ability of expired user with the STAFF_LOGIN permission to log into Evergreen (`auth.block_expired_staff_login`)
439 * Offer use of geographic location services in the public catalog (`opac.use_geolocation`)
440
441 ===== New Internal Flags =====
442
443 * Maximum search result count at which spelling suggestions may be offered (`opac.did_you_mean.low_result_threshold`)
444
445 ===== New Library Settings =====
446
447 * Allow both Shibboleth and native OPAC authentication (`opac.login.shib_sso.allow_native`)
448 * Allow renewal request if renewal recipient privileges have expired (`circ.renew.expired_patron_allow`)
449 * Enable Holdings Sort by Geographic Proximity ('opac.holdings_sort_by_geographic_proximity`)
450 * Enable Shibboleth SSO for the OPAC (`opac.login.shib_sso.enable`)
451 * Evergreen SSO matchpoint (`opac.login.shib_sso.evergreen_matchpoint`)
452 * Geographic Location Service to use for Addresses (`opac.geographic_location_service_for_address`)
453 * Keyboard distance score weighting in OPAC spelling suggestions (`search.symspell.keyboard_distance.weight`)
454 * Log out of the Shibboleth IdP (`opac.login.shib_sso.logout`)
455 * Minimum required uses of a spelling suggestions that may be offered (`search.symspell.min_suggestion_use_threshold`)
456 * Pg_trgm score weighting in OPAC spelling suggestions (`search.symspell.pg_trgm.weight`)
457 * Randomize group hold order (`holds.subscription.randomize`)
458 * Shibboleth SSO Entity ID (`opac.login.shib_sso.entityId`)
459 * Shibboleth SSO matchpoint (`opac.login.shib_sso.shib_matchpoint`)
460 * Show Geographic Proximity in Miles (`opac.geographic_proximity_in_miles`)
461 * Soundex score weighting in OPAC spelling suggestions (`search.symspell.soundex.weight`)
462
463 ===== New Stock Action/Trigger Event Definitions =====
464
465 * Hold Group Hold Placed for Patron Email Notification
466
467 === New Features ===
468
469
470 ==== Administration ====
471
472
473
474 ===== Single Sign On (Shibboleth) Public Catalog integration =====
475
476 The Evergreen OPAC can now be used as a Service Provider (SP) in a
477 Single Sign On infrastructure.  This allows system administrators to
478 connect the Evergreen OPAC to an identity provider (IdP).  Such a scenario
479 offers significant usability improvements to patrons:
480
481 * They can use the same, IdP-provided login screen and credentials that they
482 use for other applications (SPs).
483 * If they have already logged into another participating application, when
484 they arrive at the Evergreen OPAC, they can be logged in without needing to
485 enter any credentials at all.
486 * Evergreen can be configured to offer a Single Sign-out service, where
487 logging out of the Evergreen OPAC will also log the user out of all other SPs.
488
489 It can also offer security benefits, if it enables a Shibboleth-enabled
490 Evergreen installation to move away from insecure autogenerated user passwords
491 (e.g. year of birth or last four digits of a phone number).
492
493 Different Org Units can use different IdPs.  This development also supports a
494 mix of Shibboleth and non-Shibboleth libraries.
495
496 Note that only the OPAC can be integrated with Shibboleth at this time; no such
497 support exists for the staff client, self-check, etc.
498
499 Also note that this development does not include automatic provisioning of
500 accounts.  At this time, matching accounts must already exist in Evergreen
501 for a patron to successfully authenticate into the OPAC via Single Sign On.
502
503 ====== Installation ======
504
505 Installing and configuring Shibboleth support is a complex project.  In
506 broad strokes, the process includes:
507
508 . Installing Shibboleth and the Shibboleth Apache module (`apt install libapache2-mod-shib2` on Debian and Ubuntu)
509 . Configuring Shibboleth, including:
510   * Setting up a certificate
511   * assigning an Entity ID
512   * getting metadata about the IdP from the IdP (perhaps "locally maintained
513   metadata", where an XML file from the IdP is copied into place on your
514   Evergreen server)
515   * Understanding what attributes the IdP will provide about your users,
516   and describing them in the `attribute-map.xml` file.
517 . Providing your Entity ID, information about possible bindings, and any
518 other requested information to the IdP administrator.  Much of this information
519 will be available at http://YOUR_EVERGREEN_DOMAIN/Shibboleth.sso/Metadata
520 . Configuring Apache, including:
521   * Enabling Shibboleth authentication in the `eg_vhost.conf` file
522   * (Optional) Using the new _sso_loc_ Apache variable to identify
523   which org unit should be used as the context location when fetching
524   Shibboleth-related library settings.
525 . As a user with the new `SSO_ADMIN` permission, configure Evergreen using
526 the Library Settings Editor, including:
527   * Enable Shibboleth SSO for the OPAC
528   * (Optional) Configure whether you will use SSO exclusively, or offer
529   patrons a choice between SSO and standard Evergreen authentication
530   * (Optional) Configure whether or not you will use Single Log Out
531   * (Optional) In scenarios where a single Evergreen installation is
532   connected to multiple IdPs, assign org units to the relevant IdPs,
533   referenced by the IdP's Entity Id.
534   * Of the attributes defined in `attribute-map.xml`, configure which one
535   should be used to match users in the Evergreen database.  This defaults
536   to uid.
537   * For the attribute you chose in the previous step, configure which
538   Evergreen field it should match against.  Options are usrname (default),
539   barcode, and email.
540
541 This https://www.youtube.com/watch?v=SvppXbpv-5k[video on the SAML protocol] can
542 be very helpful for introducing the basic concepts used in the installation and
543 configuration processes.
544
545
546 ==== Architecture ====
547
548
549 ===== Block Login of Expired Staff Accounts =====
550
551 Evergreen now has the ability to prevent staff users whose
552 accounts have expired from logging in. This is controlled
553 by the new global flag "auth.block_expired_staff_login", which
554 is not enabled by default. If that flag is turned on, accounts
555 that have the `STAFF_LOGIN` permission and whose expiration date
556 is in the past are prevented from logging into any Evergreen
557 interface, including the staff client, the public catalog, and SIP2.
558
559 It should be noted that ordinary patrons are allowed to log into
560 the public catalog if their circulation privileges have expired. This
561 feature prevents expired staff users from logging into the public catalog
562 (and all other Evergreen interfaces and APIs) outright in order to
563 prevent them from getting into the staff interface anyway by
564 creative use of Evergreen's authentication APIs.
565
566 Evergreen admins are advised to check the expiration status of staff
567 accounts before turning on the global flag, as otherwise it is
568 possible to lock staff users out unexpectedly. The following SQL
569 query will identify expired but otherwise un-deleted users that
570 would be blocked by turning on the flag:
571
572 [source,sql]
573 ----
574 SELECT DISTINCT usrname, expire_date
575 FROM actor.usr au, permission.usr_has_perm_at_all(id, 'STAFF_LOGIN')
576 WHERE active
577 AND NOT deleted
578 AND NOT barred
579 AND expire_date < NOW()
580 ----
581
582 Note that this query can take a long time to run in large databases
583 given the general way that it checks for users that have the
584 `STAFF_LOGIN` permission. Replacing the use of
585 `permission.usr_has_perm_at_all()` with a query on expired users
586 with profiles known to have the `STAFF_LOGIN` permission will
587 be much faster.
588
589
590
591
592 ===== Migration From GIST to GIN Indexes for Full Text Search =====
593
594 Evergreen now uses GIN indexes for full text search in PostgreSQL.
595 GIN indexes offer better performance than GIST.  For more information
596 on the differences in the two index types, please refer to the
597 https://www.postgresql.org/docs/current/textsearch-indexes.html[PostgreSQL
598 documentation].
599
600 An upgrade script is provided as part of this migration.  If you
601 upgrade normally from a previous release of Evergreen, this upgrade
602 script should run as part of the upgrade process.  The migration
603 script recommends that you run a `VACUUM ANALYZE` in PostgreSQL on the
604 tables that had the indexes changed.  The migration process does not
605 do this for you, so you should do it as soon as is convenient after
606 the upgrade.
607
608 ====== Updating Your Own Indexes ======
609
610 If you have added your own full text indexes of type GIST, and you
611 wish to migrate them to GIN, you may do so.  The following query, when
612 run in your Evergreen databsase after the migration from GIST to GIN,
613 will identify the remaining GIST indexes in your database:
614
615 [source,sql]
616 ----------------------------------------
617 SELECT schemaname, indexname
618 FROM pg_indexes
619 WHERE indexdef ~* 'gist';
620 ----------------------------------------
621
622 If the above query produces output, you can run the next query to
623 output a SQL script to migrate the remaining indexes from GIST to GIN:
624
625 [source,sql]
626 ----------------------------------------
627 SELECT 'DROP INDEX ' || schemaname || '.' || indexname || E';\n' ||
628        REGEXP_REPLACE(indexdef, 'gist', 'gin', 'i') || E';\n' ||
629        'VACUUM ANAlYZE ' || schemaname || '.' || tablename || ';'
630 FROM pg_indexes
631 WHERE indexdef ~* 'gist';
632 ----------------------------------------
633
634
635
636
637 ===== Removal of Custom Dojo Build =====
638
639 Evergreen had a
640 https://wiki.evergreen-ils.org/doku.php?id=scratchpad:random_magic_spells#custom_dojo_build[method
641 of making a custom build of the Dojo JavaScript library].  Following
642 this procedure could improve the load times for the OPAC and other
643 interfaces that use Dojo.  However, very few sites took advantage of
644 this process or even knew of its existence.
645
646 As a part of the process, an `openils_dojo.js` file was built and
647 installed along with the other Dojo files.  Evergreen had many
648 references to load this optional file.  For the majority of sites that
649 did not use this custom Dojo process, this file did not exist.
650 Browsers would spend time and resources requesting this nonexistent
651 file.  This situation also contributed noise to the Apache logs with
652 the 404 errors from these requests.
653
654 In keeping with the goal of eliminating Dojo from Evergreen, all
655 references to `openils_dojo.js` have been removed from the OPAC and
656 other files.  The profile script required to make the custom Dojo
657 build has also been removed.
658
659
660
661
662
663 ====== Cataloging ======
664
665
666
667 ===== Czech language records in sample data =====
668
669 This release adds 7 Czech-language MARC records to the
670 sample data set (also known as Concerto data set).
671
672
673
674
675
676 ===== Publisher Catalog Display Includes 264 Tag =====
677
678 Publisher values are now extracted for display from tags 260 OR 264.
679
680 ====== Upgrade Notes ======
681
682 A partial reingest is required to extract the new publisher data for display.
683 This query may be long-running.
684
685 [source,sql]
686 --------------------------------------------------------------------------
687 WITH affected_bibs AS (
688     SELECT DISTINCT(bre.id) AS id
689     FROM biblio.record_entry bre
690     JOIN metabib.real_full_rec mrfr
691     ON (mrfr.record = bre.id AND mrfr.tag = '264')
692     WHERE NOT bre.deleted
693 )
694 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE)
695 FROM affected_bibs;
696 --------------------------------------------------------------------------
697
698
699
700
701
702 ==== Circulation ====
703
704
705
706 ===== Hold Groups =====
707
708 This feature allows staff to add multiple users to a named hold group
709 bucket and place title-level holds for a record for that entire set of users.
710 Users can be added to such a hold group bucket from either the patron
711 search result interface, via the Add to Bucket dropdown, or through a dedicated
712 Hold Group interface available from the Circulation menu.  Adding new
713 patrons to a hold group bucket will require staff have the PLACE_HOLD
714 permission.
715
716 Holds can be placed for the users in a hold group bucket either directly from
717 the normal staff-place hold interface in the embedded OPAC, or by supplying the
718 record ID within the hold group bucket interface.  In the latter case, the
719 list of users for which a hold was attempted but failed to be placed can be
720 downloaded by staff in order to address any placement issues.  Placing a
721 hold group bucket hold will requires staff have the MANAGE_HOLD_GROUPS
722 permission, which is new with this development.
723
724 In the event of a mistaken hold group hold, staff with the MANAGE_HOLD_GROUPS
725 permission will have the ability to cancel all unfulfilled holds created as
726 part of a hold group event.
727
728 A link to the title's hold interface is available from the list of hold group
729 events in the dedicated hold group interface.
730
731
732
733
734 ===== Scan Item as Missing Pieces Angular Port =====
735
736 The 'Scan Item As Missing Pieces' interface is now an Angular interface.
737 The functionality is the same, but the interface displays more details
738 on the item in question (title/author/callnum) before proceeding with the 
739 missing pieces process.
740
741
742
743
744 ===== Opt-In Setting for Overdue and Predue Emails =====
745
746 The "Receive Overdue and Courtesy Emails" user setting permits users to
747 control whether they receive email notifications about overdue items.
748
749 To use the setting, modify any action trigger event definitions which
750 send emails about overdue items, setting the "Opt In Setting" to
751 "circ.default_overdue_notices_enabled" and the "User Field" to "usr".
752 You can accomplish this by running the following query in your database:
753
754 ----
755 UPDATE action_trigger.event_definition
756 SET opt_in_setting = 'circ.default_overdue_notices_enabled',
757     usr_field = 'usr'
758 WHERE opt_in_setting IS NULL
759     AND hook = 'checkout.due'
760     AND reactor = 'SendEmail';
761 ----
762
763 Once this is done, the patron registration screen in the staff client
764 will show a "Receive Overdue and Courtesy Emails" checkbox, which will
765 be checked by default.  To ensure that existing patrons continue to
766 recieve email notifications, you will need to add the user setting to
767 their accounts, which you can do by running the following query in your
768 database:
769
770 ----
771 INSERT INTO actor.usr_setting (usr, name, value)
772 SELECT
773     id,
774     'circ.default_overdue_notices_enabled',
775     'true'
776 FROM actor.usr;
777 ----
778
779
780
781
782
783
784 ===== Allow Circulation Renewal for Expired Patrons =====
785
786 The "Allow renewal request if renewal recipient privileges have
787 expired" organizational unit setting can be set to true to permit
788 expired patrons to renew circulations.  Allowing renewals for expired
789 patrons reduces the number of auto-renewal failures and assumes that a
790 patron with items out eligible for renewals has not been expired for
791 very long and that such patrons are likely to renew their privileges
792 in a timely manner.
793
794 The setting is referenced based on the current circulation library for
795 the renewal.  It takes into account the global flags for "Circ: Use
796 original circulation library on desk renewal instead of the
797 workstation library" and "Circ: Use original circulation library on
798 opac renewal instead of user home library."
799
800
801
802
803 ==== OPAC ====
804
805
806
807 ===== Consistent Ordering for Carousels =====
808
809 Carousel ordering is now stable and predictable:
810
811  * Newly Cataloged Item and Newest Items by Shelving Location carousels are ordered from most recently cataloged to least recently cataloged.
812  * Recently Returned Item carousels is ordered is from most recently returned to least recently returned.
813  * Top Circulated Items carousels is ordered is from most circulated to least circulated.
814  * Manual carousels (as of now, without the ability to adjust the position of items) are in the order they are added to the backing bucket.
815   ** Emptying and refilling the bucket allows reordering.
816
817
818
819
820 ===== Default Public Catalog to the Bootstrap Skin =====
821
822 The public catalog now defaults to the Bootstrap skin rather than the
823 legacy TPAC skin.
824
825 Bootstrap is now the default in order to encourage more testing, but
826 users should be aware of the following 
827 https://bugs.launchpad.net/evergreen/+bugs?field.tag=bootstrap-blocker[issues];
828 certain specific functionality is available only in the TPAC skin.
829
830 The TPAC skin remains available for use, but current Evergreen users
831 should start actively considering migrating to the Bootstrap skin.
832
833 In order to continue to use the TPAC skin, comment out the following
834 line in `eg_vhost.conf`
835
836 [source,conf]
837 -------------------
838 PerlAddVar OILSWebTemplatePath "@localstatedir@/templates-bootstrap" # Comment this line out to use the legacy TPAC
839 -------------------
840
841
842
843 ===== Did You Mean? Single word search suggestions =====
844
845 This feature is the first in the series to add native search suggestions
846 to the Evergreen search logic.  A significant portion of the code is
847 dedicated to infrastructure that will be used in later enhancements to
848 the functionality.
849
850 ====== Overview ======
851
852 When searching the public or staff catalog in a single search class (title,
853 author, subject, series, identifier, or keyword) with a single search term
854 users can be presented with alternate search terms.  Depending on how the
855 instance has been configured, suggestions may be provided for only
856 misspelled words (as defined by existence in the bibliographic corpus),
857 terms that are spelled properly but occur very few times, or on every
858 single-term search.
859
860 ====== Settings ======
861
862 The following new library settings control the behavior of the suggestions:
863
864 * Maximum search result count at which spelling suggestions may be offered
865 * Minimum required uses of a spelling suggestions that may be offered
866 * Maximum number of spelling suggestions that may be offered
867 * Pg_trgm score weighting in OPAC spelling suggestions
868 * Soundex score weighting in OPAC spelling suggestions
869 * QWERTY Keyboard similarity score weighting in OPAC spelling suggestions 
870
871 There are also two new internal flags:
872
873 * symspell.prefix_length
874 * symspell.max_edit_distance
875
876 ====== Upgrading ======
877
878 This feature requires the addition of new Perl module dependencies.  Please
879 run the app server and database server dependency Makefiles before applying
880 the database and code updates.
881
882 At the end of the database upgrade script, the administrator is presented
883 with a set of instructions necessary to precompute the suggestion
884 dictionary based on the current bibliographic database.  The first half
885 of this procedure can be started even before the upgrade begins, as soon
886 as the Evergreen database is no longer accessible to users that might
887 cause changes to bibliographic records.  For very large instances, this
888 dictionary generation can take several hours and needs to be run on a
889 server with significant RAM and CPU resources. Please look at the upgrade
890 script before beginning an upgrade and plan this dictionary creation as
891 part of the overall upgrade procedure.
892
893 Given a server, such as a database server with 64G of RAM, you should
894 be able to run all six of the shell commands in parallel in screen
895 sessions or with a tool such as GNU parallel.
896
897 These commands invoke a script that will generate a class-specific sub-set
898 of the dictionary, and can be used to recreate the dictionary if
899 necessary in the future.
900
901
902
903
904 ===== Sort Holdings by Geographical Proximity =====
905
906 This functionality integrates 3rd party geographic lookup services to allow patrons
907 to enter an address on the record details page in the OPAC and sort the holdings
908 for that record based on proximity of their circulating libraries to the entered
909 address. To support this, latitude and longitude coordinates may be associated with
910 each org unit. Care is given to not log or leak patron provided addresses or the
911 context in which they are used.
912
913 Requires the following Perl modules: `Geo::Coder::Free`, `Geo::Coder::Google`, and `Geo::Coder::OSM`
914
915 Configuration instructions:
916
917  . Register an account with a third party geographic location service and copy the API Key.
918  . Configure the Geographic Location Service (Server Administration > Geographic Location Service > New Geographic Location Service).
919  . Enable Global Flag by navigating to Server Administration → Global Flags and locating the `opac.use_geolocation` flag. (Any entry in the Value field will be ignored.)
920  . Enable Library Setting: Enable Holdings Sort by Geographic Proximity (set to True).
921  . Enable Library Setting: Geographic Location Service to use for Addresses (use the value from the Name field entered in the Geographic Location Services Configuration entry).
922  . Enable Library Setting: Show Geographic Proximity in Miles (if not set, it will default to kilometers).
923  . Set the geographic coordinates for each location by navigating to Server Administration > Organizational Units. Select the org unit, switch to the Physical Address subtab and either manually enter Latitude and Longitude values or use the Get Coordinate button. 
924
925 Two new permissions, VIEW_GEOLOCATION_SERVICES and ADMIN_GEOLOCATION_SERVICES, control viewing and editing values in the Geolocation Location Services interface. They are added to the System Administrator and Global Administrator permissions groups by default.
926
927
928 ===== Library Groups =====
929
930 The Library Groups search feature revives a longstanding internal
931 concept in Evergreen called "Lassos," which allows an administrator
932 to define a group of organizational units for searching outside of
933 the standard organizational unit hierarchy.
934
935 Use case examples include creating a group of law or science
936 libraries within a university consortium, or grouping all school
937 libraries together within a mixed school/public library consortium.
938
939 Searches can be restricted to a particular Library Group from the
940 library selector in the public catalog basic search page and from
941 the new "Where" selector on the advanced search page.
942
943 Restricting catalog searches by Library Group is available only
944 in the public catalog and "traditional" staff catalog; it is not
945 available in the Angular staff catalog.
946
947 This feature adds a new permission, `ADMIN_LIBRARY_GROUPS`, that
948 allows updating Library Groups and Library Group Maps. This permission
949 is not associated with any profiles by default, and replaces
950 the `CREATE_LASSO`, `UPDATE_LASSO`, and `DELETE_LASSO` permissions. 
951
952 To define new library groups, use the Server Administration Library
953 Groups and Library Group Maps pages. An autogen and a reload of
954 Apache should be performed after making changes to Library Groups.
955
956
957 ===== Easier Styling of Public Catalog Logo and Cart Images =====
958
959 Evergreen now has IDs associated with logos and cart images in the TPAC and Bootstrap OPACs to aid in customization.  Images are as follows:
960
961 * small Evergreen logo in navigation bar is 'topnav_logo_image'
962 * the large Evergreen logo in the center of the splash page of the TPAC is 'homesearch_main_logo_image' 
963 * the cart icon is 'cart_icon_image' 
964 * the small logo in the footer is 'footer_logo_image'
965
966 The Bootstrap OPAC does not have a homesearch logo icon as it is added in the background by CSS and can be directly styled through the CSS.
967
968
969
970
971 ===== Easier TPAC Customization via colors.tt2 =====
972
973 Twelve new colors for TPAC have been added to the colors.tt2 file as well as 
974 having corresponding changes to the style.css.tt2 file. These use 
975 descriptive rather than abstract names. These changes help avoid 
976 situations were unreadable values are placed on top of each other 
977 and where different values are wanted for elements that only refernece 
978 a single color previously. Guidelines are below for setting values that 
979 correspond to the previous values used in the colors.tt2 file.  
980 For more diverse customizations the OPAC should be reviewed before 
981 a production load.
982
983 * 'footer' is used for the background color of the footer. It replaces the 
984 'primary'.
985 * 'footer_text' sets the text color in the footer and replaces 'text_invert' 
986 * 'header' sets the background of the header and replaces 'primary_fade'
987 * 'header_text' sets the color of text in the header and replaces 'text_invert'
988 * 'header_links_bar' sets the background of the links bar that separates the 
989 header on the front page of the opac and replaces 'background_invert'
990 * 'header_links_text' sets the text on the links bar and replaces 'text_invert'
991 * 'header_links_text_hover' set the hover text color on the links bar and 
992 replaces 'primary'
993 * 'opac_button' sets the background color of the My Opac button and replaces 
994 'control'
995 * 'opac_button_text' explicitly sets the text color on the My Opac button  
996 * 'opac_button_hover' sets the background color of the My Opac button when the 
997 mouse is hovering over it and replaces 'primary'
998 * 'opac_button_hover_text' sets the text color of the My Opac button when the 
999 mouse is hovering over it and replaces 'text invert'
1000
1001 Note that is patch is primarily meant for users who wish to continue
1002 using TPAC rather than the Bootstrap skin for a while; new Evergreen
1003 users are advised to use the now-default Bootstrap skin.
1004
1005
1006
1007 ===== Configurable Read More Accordion for OPAC Search and Record View (TPAC) =====
1008
1009 ====== Read More Button ======
1010
1011 Public catalog record fields (in the TPAC skin only) now truncate
1012 themselves based on a configurable amount of characters.  The full
1013 field may be displayed upon hitting a (Read More) link, which will
1014 then toggle into a (Read Less) link to re-truncate the field.
1015
1016 ====== Configuration ======
1017
1018 `Open-ILS/src/templates/opac/parts/config.tt2` contains two new
1019 configuration variables:
1020
1021
1022 * `truncate_contents` (default: 1)
1023 * `contents_truncate_length` (default: 50).
1024
1025 Setting `truncate_contents` to 0 will disable the read more
1026 functionality.  The variable `contents_truncate_length` corresponds
1027 to the amount of characters to display before truncating the text.
1028 If `contents_truncate_length` is removed, it will default to 100.
1029
1030 Additional configuration for note fields can be made in
1031 `Open-ILS/src/templates/opac/parts/record/contents.tt2`, allowing a
1032 `trunc_length` variable for each individual type of note, which will
1033 override `contents_truncate_length` for that specific
1034 type of note.
1035
1036
1037 ====== Adding Read More Functionality to further fields ======
1038
1039 To add Read More functionality to any additional fields, you may use
1040 the macro `accordion()`, defined in `misc_util.tt2`. It can take three
1041 variables: `str`, `trunc_length`, and `element`. `str` corresponds to
1042 the string you want to apply it to, `trunc_length` (optional) will
1043 override `contents_truncate_length` if supplied, and `element`
1044 (optional) provides an alternative HTML element to look at for the
1045 truncation process (useful in situations such as the Authors and Cast
1046 fields, where each field is processed individually, but needs to be
1047 treated as a single field).
1048
1049
1050
1051
1052 ==== Reports ====
1053
1054
1055 ===== Reports Scheduler Improvements =====
1056
1057 Previously, the reports scheduler allowed duplicated reports
1058 under certain circumstances.  A uniqueness constraint now
1059 disallows this without adversely affecting the reports process.
1060
1061
1062
1063 ==== Miscellaneous ====
1064
1065 * The 'Create Reservation' form in the Booking module now includes
1066   an option to search for the patron by attributes other than just
1067   their barcode. (https://bugs.launchpad.net/evergreen/+bug/1816655[Bug 1816655])
1068 * The form to add a user to a Course now includes an option to search
1069   for the patron by attributes other than just their barcode. (https://bugs.launchpad.net/evergreen/+bug/1907921[Bug 1907921])
1070 * For consistency with the menu action Cataloging => Retrieve Record by
1071   TCN Value, the staff catalog Numeric Search => TCN search now includes
1072   deleted bib records. (https://bugs.launchpad.net/evergreen/+bug/1881650[Bug 1881650])
1073 * Add a new command-line script, `overdrive-api-checker.pl`, for testing
1074   the OverDrive API. (https://bugs.launchpad.net/evergreen/+bug/1696825[Bug 1696825])
1075 * The Shelving Location Groups editor is ported to Angular. (https://bugs.launchpad.net/evergreen/+bug/1852321[Bug 1852321])
1076 * The staff catalog now has the ability to add all search results (up to
1077   1,000 titles) to the basket in one fell swoop. (https://bugs.launchpad.net/evergreen/+bug/1885179[Bug 1885179])
1078 * Add 'All Videos' as a search format. (https://bugs.launchpad.net/evergreen/+bug/1917826[Bug 1917826])
1079 * Server-side print templates can now have print contexts set. (https://bugs.launchpad.net/evergreen/+bug/1891550[Bug 1891550])
1080 * Add ability to set the print context for a print template to "No-Print"
1081   to specify, well, that a given receipt should never be printed. (https://bugs.launchpad.net/evergreen/+bug/1891550[Bug 1891550])
1082 * Add Check Number as an available column to the Bill History grids. (https://bugs.launchpad.net/evergreen/+bug/1705693[Bug 1705693])
1083 * Adds a new control to the item table in the TPAC public catalog only to
1084   specify that only items that are available should be displayed. (https://bugs.launchpad.net/evergreen/+bug/1853006[Bug 1853006])
1085 * Adds warning before deleting bib records with holds (https://bugs.launchpad.net/evergreen/+bug/1398107[Bug 1398107])
1086 * Library scope on (Angular) Administration pages now defaults to workstation location rather than consortium (https://bugs.launchpad.net/evergreen/+bug/1873322[Bug 173322])
1087 * Pending users now set last four digits of phone number as password when library setting is enabled (https://bugs.launchpad.net/evergreen/+bug/1887852[Bug 1887852])
1088
1089 === Acknowledgments ===
1090
1091 The Evergreen project would like to acknowledge the following
1092 organizations that commissioned developments in this release of
1093 Evergreen:
1094
1095 * BC Libraries Cooperative
1096 * Community Library (Sunbury)
1097 * Consortium of Ohio Libraries (COOL)
1098 * Evergreen Community Development Initiative
1099 * Evergreen Indiana
1100 * Georgia PINES
1101 * Linn-Benton Community College
1102 * Pennsylvania Integrated Library System (PaILS)
1103
1104
1105 We would also like to thank the following individuals who contributed
1106 code, translations, documentation, patches, and tests to this release of
1107 Evergreen:
1108
1109 * John Amundson
1110 * Zavier Banks
1111 * Felicia Beaudry
1112 * Jason Boyer
1113 * Dan Briem
1114 * Andrea Buntz Neiman
1115 * Christine Burns
1116 * Galen Charlton
1117 * Garry Collum
1118 * Eva Cerniňáková
1119 * Dawn Dale
1120 * Elizabeth Davis
1121 * Jeff Davis
1122 * Martha Driscoll
1123 * Bill Erickson
1124 * Jason Etheridge
1125 * Ruth Frasur
1126 * Blake Graham-Henderson
1127 * Katie Greenleaf Martin
1128 * Rogan Hamby
1129 * Elaine Hardy
1130 * Kyle Huckins
1131 * Angela Kilsdonk
1132 * Tiffany Little
1133 * Mary Llewellyn
1134 * Terran McCanna
1135 * Chauncey Montgomery
1136 * Gina Monti
1137 * Michele Morgan
1138 * Carmen Oleskevich
1139 * Jennifer Pringle
1140 * Mike Risher
1141 * Mike Rylander
1142 * Jane Sandberg
1143 * Chris Sharp
1144 * Ben Shum
1145 * Remington Steed
1146 * Jason Stephenson
1147 * Jennifer Weston
1148 * Beth Willis
1149
1150 We also thank the following organizations whose employees contributed
1151 patches:
1152
1153 * BC Libraries Cooperative
1154 * Calvin College
1155 * Catalyte
1156 * CW MARS
1157 * Equinox Open Library Initiative
1158 * Georgia Public Library Service
1159 * Kenton County Public Library
1160 * King County Library System
1161 * Linn-Benton Community College
1162 * MOBIUS
1163 * NOBLE
1164 * Westchester Library System
1165
1166 We regret any omissions.  If a contributor has been inadvertently
1167 missed, please open a bug at http://bugs.launchpad.net/evergreen/
1168 with a correction.
1169