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