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