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