Docs: adding 2.12.11 release notes
[Evergreen.git] / docs / RELEASE_NOTES_2_12.adoc
1 Evergreen 2.12 Release Notes
2 ============================
3 :toc:
4 :numbered:
5
6 Evergreen 2.12.11
7 -----------------
8 This release contains bug fixes improving on Evergreen 2.12.10:
9
10 * The MARC Editor in the Web staff client now wraps long fields.
11 * The MARC Editor no longer allows catalogers to enter new lines
12 into MARC subfields.
13 * Fixes an issue in the Web staff client reports module that caused
14 syntax errors in reports that use virtual fields and joins.
15 * Fixes an issue that created duplicate copy data when copies or
16 volumes with parts were transferred.
17 * Fixes an issue with the http -> https redirect on Apache 2.4.
18 * Fixes an color contrast accessibility issue in the Web staff
19 client.
20 * Adds automated regression and unit tests for the Web staff client
21 reports module.
22
23
24 Acknowledgements
25 ~~~~~~~~~~~~~~~~
26 We would like to thank the following individuals who contributed code,
27 tests and documentation patches to the 2.12.11 point release of
28 Evergreen:
29
30 * Galen Charlton
31 * Blake Graham-Henderson
32 * Kathy Lussier
33 * Remington Steed
34 * Jason Stephenson
35 * Cesar Velez
36
37
38
39 Evergreen 2.12.10
40 -----------------
41 This release contains bug fixes improving on Evergreen 2.12.9:
42
43 * The patron bills screen now prevents staff members from double-clicking
44 on the Apply Payment button (which otherwise would apply two payments).
45 * Fixes a performance bug related to patrons logging in by barcode.
46
47 Acknowledgements
48 ~~~~~~~~~~~~~~~~
49 We would like to thank the following individuals who contributed code,
50 tests and documentation patches to the 2.12.10 point release of
51 Evergreen:
52
53 * Galen Charlton
54 * Bill Erickson
55 * Jason Stephenson
56 * Dan Wells
57
58 Evergreen 2.12.9
59 ----------------
60 This release contains bug fixes improving on Evergreen 2.12.8:
61
62 * NodeJs is now installed from source, rather than using a pre-compiled binary.
63 * NodeJs is now at version 6.11.3, which is the most recent LTS release.
64
65 Acknowledgements
66 ~~~~~~~~~~~~~~~~
67 We would like to thank the following individuals who contributed code,
68 tests and documentation patches to the 2.12.9 point release of
69 Evergreen:
70
71 * Jeanette Lundgren
72 * Ben Shum
73 * Remington Steed
74
75 Evergreen 2.12.8
76 ----------------
77 This release contains several bug fixes improving on Evergreen 2.12.7:
78
79 * Many patron fields have been redacted from the web staff client's patron
80 and record holds grids, leaving patron name, username, and ID.
81 * Fixes two bugs where patron records could fail to be saved upon editing.
82 * The patron summary in the web staff client now correctly displays
83 primary and secondary ID values.
84 * Patron barcode search completion in the web staff client now allows
85 the user to select from all of the matching patron records.
86 * The web staff print templates for current and historical bills can
87 now include copy barcode and title.
88 * Fixes a bug that resulted in some catalog searches unexpectedly
89 timing out.
90 * Fixes a bug where placing a hold request in the public catalog could result
91 in "forgetting" the type and library of the user's previous search.
92 * Fixes a bug that made using the volume/copy editor to change a copy's
93 price problematic.
94 * The administration interface for hard due dates now ensures that
95 new (or edited) ceiling dates have their time component set to end
96 of day, resolving an issue where ceiling dates would not be applied
97 during the ceiling date itself.
98 * Asset merging during bibliographic record merging now correctly
99 recognizes call number prefixes and suffixes and deletes disused
100 call number records.
101 * The Concerto sample data set now includes data allowing for testing
102 placing holds on monographic parts.
103 * Fixes a bug where displaying user surveys could result in PCRUD
104 drone starvation.
105 * Fixes a bug where pg_restore of an Evergreen database could fail
106 to create certain indexes on the `actor.usr` table.
107
108 Acknowledgements
109 ~~~~~~~~~~~~~~~~
110 We would like to thank the following individuals who contributed code,
111 tests and documentation patches to the 2.12.8 point release of
112 Evergreen:
113
114 * Alex Cautley 
115 * Ben Shum 
116 * Bill Erickson 
117 * Cesar Velez 
118 * Chris Sharp 
119 * Galen Charlton 
120 * Jason Boyer 
121 * Jason Stephenson 
122 * Jeff Davis 
123 * Jeff Godin 
124 * Kathy Lussier 
125 * Kyle Huckins 
126 * Michele Morgan 
127 * Mike Rylander 
128 * Remington Steed 
129 * Rogan Hamby 
130
131 Evergreen 2.12.7
132 ----------------
133 This release contains several bug fixes improving on Evergreen 2.12.6
134
135 * Fixes a bug in the web staff client that prevented initials from being
136 stored with copy notes.
137 * Adds billing types that may have been missed by systems that were 
138 running Evergreen prior to the 1.4 release.
139 * Fixes a web staff client bug with the CSV export option available from
140 the Import Queue in the MARC Batch Import/Export interface.
141 * Adds the missing copy alert field in the web client's volume/copy
142 editor.
143 * Fixes a bug where the setting to require date of birth in patron
144 registration was not being honored in the web staff client.
145 * Fixes a bug in the web staff client patron registration form where the 
146 password wasn't generating from the last four digits of the patron's
147 phone number.
148 * Fixes an issue in the web staff client where the complete barcode did
149 not display in some interfaces when partial barcodes were scanned.
150
151 Acknowledgements
152 ~~~~~~~~~~~~~~~~
153 We would like to thank the following individuals who contributed code,
154 tests and documentation patches to the 2.12.7 point release of
155 Evergreen:
156
157 * Galen Charlton
158 * Bill Erickson
159 * Jeanette Lundgren
160 * Kathy Lussier
161 * Mike Rylander
162 * Jane Sandberg
163 * Chris Sharp
164 * Ben Shum
165 * Remington Steed
166 * Cesar Velez
167
168
169 Evergreen 2.12.6
170 ----------------
171 This release contains several bug fixes improving on Evergreen 2.12.5.
172
173 * Removes the option to add a title to My List from Group Formats and
174 Editions searches where the option never worked correctly due to a bad id.
175 * Removes deleted shelving locations from the web client's volume/copy editor. Since there is no database constraint that prevents a copy from a deleted shelving location, if there are already copies attached to those shelving locations, the copy location selector will be blank. Evergreen admins can identify those items by running the following query:
176
177 ----
178 select acp.id, acp.barcode, acpl.name
179 from asset.copy acp
180 join asset.copy_location acpl on (acpl.id = acp.location)
181 where not acp.deleted
182 and acpl.deleted
183 order by acp.id;
184 ----
185 * Adds the patron opt-in check in the web client whenever a patron is retrieved
186 by barcode scan, patron search, or item circ history.
187 * Fixes a bug where the price and acquisitions cost fields did not display
188 their values. 
189 * Fixes a bug where a patron's circulation history no longer moved to the lead
190 account when merging patron accounts.
191 * Now hides the ebook tabs in My Account for sites that have not yet enabled the
192 Ebook API service.
193 * Trims spaces from patron barcodes in the web client check out interface.
194 * Makes a string in the holds validation alert translatable. 
195 * Fixes a bug that prevented the web client patron registration screen from
196 loading when there is an opt-in action triggers, such as the email checkout
197 receipt, t set to be a registration default. 
198 * Fixes a bug where barcode validation in the web client patron editor was 
199 using the incorrect regular expression.
200 * Replaces an empty string in the mobile carrier dropdown menu with a 'Please
201 select your mobile carrier' label to improve usability and resolve a problem
202 with translations.
203 * Restores the ability to display a photo in the web client patron editor for
204 accounts that have an actor.usr.photo_url.
205 * Fixes a Firefox display issue in the web client that occurred when retrieving
206 a bib record by TCN when the MARC Edit tab was set as the default view.
207 * Fixes an bug where setting a patron's default pickup location in the web 
208 client patron editor inadvertently changed the home library. It also disables
209 any locations that are not viable pickup locations.
210 * Fixes a bug where a misscan in a copy bucket failed silently.
211
212 Acknowledgements
213 ~~~~~~~~~~~~~~~~
214 We would like to thank the following individuals who contributed code,
215 tests and documentation patches to the 2.12.6 point release of
216 Evergreen:
217
218 * Jason Boyer
219 * Galen Charlton
220 * Jeff Davis
221 * Bill Erickson
222 * Jason Etheridge
223 * Blake Henderson
224 * Skye Howard
225 * Kathy Lussier
226 * Terran McCanna
227 * Jane Sandberg
228 * Ben Shum
229 * Cesar Velez
230
231 Evergreen 2.12.5
232 ----------------
233 This release contains several bug fixes improving on Evergreen 2.12.4.
234
235 * Hides the _Hold is Behind Circ Desk_ checkbox in the XUL client's patron
236 registration screen for those libraries that have not enabled Behind Desk Pickup 
237 support via the Library Settings Editor
238 * Adds a missing error string that appears when marking an item damaged from
239 an aged circulation.
240 * Changes the hold request form so that it no longer defaults to the first SMS
241 carrier for text notifications.
242 * Adds a requirement for users to enter a phone/SMS number when they have
243 enabled that notification method on the hold request form.
244 * Changes the URL pointing to catalog images, CSS and javascript files to a full
245 absolute URL instead of the relative URL previously used. This change fixes an
246 issue with the Open Graph image property, which requires a full URL.
247 * Fixes an issue where payment amounts sent to Stripe can be one cent less than
248 the actual Evergreen payment.
249 * Fixes an issue where the open-ils.storage OpenSRF module fails to start when
250 using perl 5.24 or higher.
251 * Fixes a problem in the web client where marking a transaction as claims
252 returned or claims never checked out at the same time the patron's record is
253 edited would not increase the count once the patron's record is saved.
254 * Changes the cursor to a pointer for the record menus in the web client.
255 * Fixes hardcoded patchs in srfsh support scripts.
256 * Prevents a "Use of freed value in iteration" error that appeared in logs when
257 adjusting a transaction to zero.
258 * Prevents the temporary list page from crashing when a user adds the same title
259 to the list more than once.
260 * Removes duplicate rows from localized 950.data.seed-values.sql files.
261 * Fixes the following two issues with conjoined items:
262    - Foreign items previously did not display there was no extra copy attached
263 to the bib record.
264    - Conjoined items did not display unless there were two or more items in a
265 set.
266 * Fixes an issue in the web client where the Hold Verify prompt did not display
267 for items in a Copy Location where the hold verify flag is enabled.
268 * Fixes support for automatic item barcode completion in the web client check in,
269 check out, renew, and item status interfaces.
270 * Makes the courier code variable available for transit slips in the web client.
271 * Fixes the ability to apply funds from the acquisitions selection list, 
272 View/Place Order, and MARC Federated Search interfaces.
273
274 Acknowledgements
275 ~~~~~~~~~~~~~~~~
276 We would like to thank the following individuals who contributed code,
277 tests and documentation patches to the 2.12.5 point release of
278 Evergreen:
279
280 * Galen Charlton
281 * Jeff Davis
282 * Bill Erickson
283 * Jason Etheridge
284 * Kathy Lussier
285 * Michele Morgan
286 * Mike Rylander
287 * Dan Scott
288 * Chris Sharp
289 * Ben Shum
290 * Josh Stompro
291 * Cesar Velez
292 * Liam Whalen
293 * Dan Wells
294
295
296
297 Evergreen 2.12.4
298 ----------------
299 Upgrade Notes
300 ~~~~~~~~~~~~~
301 * This release of Evergreen contains a fix to the _Hold/Copy Ratio per Bib
302 and Pickup Library (and Descendants)_ data source. Report templates using
303 this data source will need to be re-created to improve accuracy of the
304 data reported from this source.
305 * This release also contains a fix to downloading large checkout histories from
306 My Account. This feature no longer uses the action/trigger mechanism and the 
307 OPAC now generates the CSV directly.  The old action/trigger code is still
308 present in the database and should be removed at some point in the
309 near future.
310
311 Bug Fixes
312 ~~~~~~~~~
313 This release contains several bug fixes improving on Evergreen 2.12.3
314
315
316 * A fix to a web client bug where adding copies through the _Add Volumes 
317 and Copies_ menu item could fail silently.
318 * A fix to a bug that allowed users to access some web client admin interfaces 
319 without a login.
320 * A fix to the display of the loan duration and fine level fields in the web
321 client Item Status Detail view.
322 * A fix to the display of duplicate data on the bib record View Holds page when 
323 toggling between the holds and OPAC view. 
324 * A fix to a bug that prevented the web client patron registration page from
325 loading.
326 * Support for Org Unit Includes alert text, notice text, event text, header
327 text, and footer text in the web client print templates.
328 * A fix to make the web client MARC Editor's flat text editor selection sticky.
329 * A fix to make the Patron Search library selector sticky.
330 * A fix to a bug in the web client that prevented the user from saving a new
331 copy after using the MARC Edit _Add Item_ option.
332 * A fix to a patron registration bug that did not require the entry of a required
333 user statistical category for stat cats that do not allow free-text entries.
334 * The addition of the bad bacode image file in the web client.
335 * An improvement to the MARC Batch Edit progress indicator to reduce the 
336 likelihood of system backlogs.
337 * Downloading checkout history as a CSV from My Account has been fixed
338 for users with a large circulation history.  Previously, this would
339 time out for patrons with more than 100 or so circulations.
340 * A fix to syntax in the Spanish lang.dtd file that was creating an error
341 when using the Closed Date Editor.
342 * Improvements to CSS to silence some Mozilla extension warnings.
343 * A fix to a failure to update targeted circulations when utilzing the recall
344 functionality.
345 * The addition of text wrapping in the copy details table on the bib
346 record to prevent contents from falling off the page.
347 * A fix to the adjust to zero option so that it can be applied correctly
348 to multiple billings.
349 * A fix to the "Hold/Copy Ratio per Bib and Pickup Library
350 (and Descendants)" data source so that it will now include counts of eligible
351 copies at locations that are not a pickup library for bib's holds.
352 * A fix to the XUL client Item Status -> Alternate View -> Holds / Transit
353 tab so that it properly refreshes all data when switching between copies.
354
355 Acknowledgements
356 ~~~~~~~~~~~~~~~~
357 We would like to thank the following individuals who contributed code,
358 tests and documentation patches to the 2.12.4 point release of
359 Evergreen:
360
361 * Jason Boyer
362 * Galen Charlton
363 * Jeff Davis
364 * Bill Erickson
365 * Jason Etherige
366 * Pasi Kallinen
367 * Angela Kilsdonk
368 * Kathy Lussier
369 * Michele Morgan
370 * Mike Rylander
371 * Jane Sandberg
372 * Dan Scott
373 * Ben Shum
374 * Jason Stephenson
375 * Josh Stompro
376 * Cesar Velez
377 * Dan Wells
378
379 Evergreen 2.12.3
380 ----------------
381
382 This release contains several bug fixes improving on Evergreen 2.12.2.
383
384 Web Client Bug Fixes
385 ~~~~~~~~~~~~~~~~~~~~
386 The web client, which is available for trial production use in libraries,
387 received several fixes in this release:
388
389 * The receipt on payment checkbox now prints a receipt at time of payment.
390 * The Items Out count in the patron screen now includes long overdue
391 items.
392 * A fix was added to prevent values from a previously-edited patron from
393 appearing in the edit form of a subsequent patron.
394 * User notification preferences now save correctly in the patron
395 registration and edit forms.
396 * The UPDATE_MARC permission is no longer requested when performing a
397 search from the staff catalog.
398 * Non-cataloged circulations now display in the Items Out screen without
399 requiring a refresh.
400 * Required statistical categories are now required to be entered in the 
401 copy editor. (A similar bug for the patron editor was fixed in the 2.12.1
402 release).
403 * Voiding bills now requires confirmation.
404 * Staff can no longer use the copy editor to put items into or out of the
405 following statuses: checked out, lost, in transit, on holds shelf, long
406 overdue, and canceled transit.
407 * The contrast is improved for alert text showing the amount a patron owes
408 in bills.
409 * Circ modifiers now sort alphabetically in the copy editor.
410
411 Other Bug Fixes
412 ~~~~~~~~~~~~~~~
413 * Code to prevent a hold already on the Holds Shelf from being
414 transferred to another title.
415 * A fix to a bug that prevented users from scheduling reports with a
416 relative month if the report template used a date that applied the Year +
417 Month transform with the On or After (>=) operator.
418 * A fix to a bug where the max fines threshold was reached prematurely
419 due to the presence of account adjustments.
420 * A check that prevents a SMS message from attempting to sending when the SMS
421 carrier is null.
422 * For systems that provide search format as a filter on the advanced
423 search page, a fix so that the format selected in the search bar when
424 launching a new search from the results page overrides any previously-set 
425 formats.
426 * The addition of an optional new Apache/mod_perl configuration variable for
427 defining the port Apache listens on for HTTP traffic. This resolves an issue
428 where added content lookups attempting HTTP requests on the local Apache
429 instance on port 80 failed because Apache was using non-standard ports.
430 * A fix to the public catalog's My List page responsive design so that it now
431 displays properly on mobile devices and allows users to place holds from My List. 
432 * A fix to a bug where the second (and subsequent)
433 pages of search results in the public catalog (when group
434 formats and editions is in effect) does not correctly generate
435 links to hits that are not part of of a multi-bib metarecords.
436
437 Acknowledgements
438 ~~~~~~~~~~~~~~~~
439 We would like to thank the following individuals who contributed code,
440 testing and documentation patches to the 2.12.3 point release of
441 Evergreen:
442
443 * Jason Boyer
444 * Galen Charlton
445 * Jeff Davis
446 * Bill Erickson
447 * Jason Etheridge
448 * Kathy Lussier
449 * Terran McCanna
450 * Dan Scott
451 * Chris Sharp
452 * Ben Shum
453 * Remington Steed
454 * Cesar Velez
455 * Dan Wells
456
457 Evergreen 2.12.2
458 ----------------
459
460 This release is a security release that also contains several other bug
461 fixes improving on Evergreen 2.12.1.
462
463 Security Issue: XSS Vulnerability in Public Catalog
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465 This release fixes several cross-site scripting (XSS) vulnerabilities
466 in the public catalog. When upgrading, Evergreen administrators should
467 review whether any of the following templates have been customized
468 or overridden. If so, either the template should be replaced with the
469 stock version or the XSS fix (which entails adding the `| html` filter
470 in several places) applied to the customized version.
471
472 * `Open-ILS/src/templates/opac/parts/locale_picker.tt2`
473 * `Open-ILS/src/templates/opac/parts/login/form.tt2`
474 * `Open-ILS/src/templates/opac/parts/searchbar.tt2`
475
476 Upgrade Notes
477 ~~~~~~~~~~~~~
478 * Administrators of Evergreen who use RTL locales and who have customized
479 `style-rtl.css.tt2` should now incorporate their customizations into
480 `style.css.tt2`.
481 * The `reporter.classic_current_circ` view, which is part of some
482 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
483 has been fixed to not exclude loans for patrons who do not have a
484 billing address set. Users of this view should rerun
485 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
486
487 Hold Targeter Repairs and Improvements
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489 A series of changes were made to the new hold targeter available in 2.12.
490
491 * Make the batch targeter more resilient to a single-hold failure.
492 * Additional batch targeter info logging.
493 * Set OSRF_LOG_CLIENT in hold_targeter_v2.pl for log tracing
494 * Removes the confusingly named --target-all option
495  ** The same behavior can be achieved by using --retarget-interval "0s"
496 * Removes --skip-viable (see --soft-retarget-interval below)
497
498 New --next-check-interval Option
499 ++++++++++++++++++++++++++++++++
500 Specify how long after the current run time the targeter will retarget
501 the currently affected holds. Applying a specific interval is useful
502 when the retarget-interval is shorter than the time between targeter
503 runs.
504
505 For example, if the targeter is run nightly at midnight with a
506 --retarget-interval 36h, you would set --next-check-interval to 48hr,
507 since the holds won't be processed again until 48 hours later. This
508 ensures that the org unit closed date checks are looking at the correct
509 date. 
510
511 This setting overrides the default behavior of calculating the next 
512 retarget time from the retarget-interval.
513
514 New --soft-retarget-interval Option
515 +++++++++++++++++++++++++++++++++++
516 This is a replacement for (and rebranding of) the --skip-viable option. 
517 The new option allows for time-based soft-targeting instead simple binary 
518 on/off soft-targeting.
519
520 How soft-targeting works:
521 * Update hold copy maps for all affected holds
522 * Holds with viable targets (on the pull list) are otherwise left alone.
523 * Holds without viable targets are retargeted in the usual manner. 
524
525 Other Bug Fixes
526 ~~~~~~~~~~~~~~
527 * A fix to remove the Chilifresh patron reviews header for Evergreen sites
528 that do not use Chilifresh.
529 * A fix that marks acquisitions POs as received when all line items on the 
530 PO are received or canceled.
531 * A typo fix to the long overdue override permission that prevented staff
532 from being able to override long overdue check ins.
533 * A fix to use a library's configured currency in SIP patron responses
534 instead of always using US dollars.
535 * A fix to SIP timeouts caused by invalid sessions
536 * A fix that allows boolean fields to be recognized in queries to the
537 Z39.50 server.
538 * A fix to use the correct method during adjust to zero on negative
539 balances.
540 * A correction to the datatype for the Vandelay Default Record Match Set
541 setting.
542 * The removal of the _Keep_ field from MARC Batch Import Item Attributes.
543 The field was not previously implemented.
544 * A fix to set the complete time value for grouped Action/Trigger events
545 when an event's state reach complete, consistent with non-grouped events.
546 * A fix to a bug in the rollover_phone_to_print.pl script that kept failed
547 call files from being moved.
548 * A new index for acq.edi_message that speeds up the check for duplicate
549 EDI messages.
550 * A fix that ensures JSON strings are converted to UTF8, ensuring that
551 non-ASCII data display correctly.
552 * A fix to avoid an erroneous unsaved data popup to appear during MARC
553 record creation.
554 * A typo fix in the web client's bill payment receipt template.
555 * A correction to ebook account links on the My Account Summary page.
556 * Improved responsive design for the ebook My Account screens so that
557 they display better on mobile devices.
558 * A fix to a bug that prevented a patron opt-in dialog from loading.
559 * The RTL stylesheet for the public catalog,
560 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
561 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
562 template will emit RTL or LTR styles based on the value of
563 the `rtl` flag of the active locale. An `rtl` variable is also available
564 in the template to allow the correct style to be chosen.
565 * A fix to leaking of the internal port number to the client when
566 Apache is configured to use nonstandard ports in combination with a proxy
567 server.
568 * The addition of the vandelay.auto_overlay_bib_record upgrade script,
569 which was missed in a 2.1-2.2 era upgrade script. It isn't necessary for
570 sites that began using Evergreen since then to run the script, but
571 it is harmless to run.
572 * A web staff client fix that will hid the behind-desk option for
573 for libraries that do not support "Behind Desk Pickup".
574 * A web staff client fix that caused hold transit check ins to fail
575 silently when the transit destination does not have a holds address.
576 * A web staff client fix that now requires the entry of user statistical
577 categories in the patron editor if those stat cats are configured to
578 be required.
579 * A fix to a problem with the "Exclude Electronic Resources" checkbox
580 that prevented users from removing a selection from the box.
581 * The removal of the search format limiters from the new advanced search
582 limiter block on the search results page. The search format limiters
583 should not display there because they can be selected from the search bar.
584
585
586
587
588 Acknowledgements
589 ~~~~~~~~~~~~~~~~
590 We would like to thank the following individuals who contributed code,
591 testing and documentation patches to the 2.12.2 point release of
592 Evergreen:
593
594 * Galen Charlton
595 * Jeff Davis
596 * Bill Erickson
597 * Jason Etheridge
598 * Jeff Godin
599 * Blake Henderson
600 * Linda Jansova
601 * Kathy Lussier
602 * Jillianne Presley
603 * Jane Sandberg
604 * Dan Scott
605 * Chris Sharp
606 * Remington Steed
607 * Jason Stephenson
608 * Josh Stompro
609 * Remington Steed
610
611 Evergreen 2.12.1 
612 ----------------
613
614 This release contains several bug fixes improving on Evergreen 2.12.0
615
616 * A fix to the 2.12 upgrade of the subject|temporal and subject|geographic 
617 indexes, where the above-mentioned browse indexes were not turned off in favor
618 of new browse versions of the indexes. Sites that are upgrading from 2.12.0
619 can cancel the browse reingest that comes with the new upgrade script.
620
621 * A change to the default pickup library when staff place a hold. The place hold
622 screen will now default to the preferred pickup location for the patron. If the
623 patron does not have a preferred pickup location, it will default to the
624 patron's home library.
625 * A fix to a problem where users could not change the selected Org Unit on the
626 MARC Tag Tables server admin page.
627 * A fix to the seed data for translations for some Coded Value Map entries.
628 * The ability to skip the XUL staff client build when in make_release.
629 * Revised layout and styling for the advanced search limiter block that displays
630 on the search results page.
631 * A fix that silences a log warning that appears for every checkout where a hard
632 due date is not used.
633 * Tweaks for sounds that are used in the web staff client.
634 * The addition of f4 and ctrl-f2 as hotkeys in the web staff client.
635 * Additional help text for receipt templates in the web staff client.
636 * The reinstatement of the Reprint Last Receipt functionality in the web staff client.
637 * The ability in the web staff client copy editor to add new volumes to
638 libraries that were not selected in holdings view.
639 * A fix to a billing issue where transactions were not re-opened after they
640 acquired a non-zero balance at check in.
641 * A change to the web staff client work log to prevent it from storing 
642 unnecessary data.
643 * A fix to a translation issue for the record attributes displayed in the 
644 advanced search limiter block on the search results page.
645 * A fix to hold targeting for metarecord holds when the new hold targeter is
646 run in parallel mode.
647
648 Acknowledgements
649 ~~~~~~~~~~~~~~~~
650 We would like to thank the following individuals who contributed code,
651 testing and documentation patches to the 2.12.1 point release of
652 Evergreen:
653
654 * Eva Cerniňáková
655 * Galen Charlton
656 * Bill Erickson
657 * Jason Etherige
658 * Jeanette Lundgren
659 * Kathy Lussier
660 * Mike Rylander
661 * Jane Sandberg
662 * Dan Scott
663 * Ben Shum
664 * Robert Soulliere
665 * Jason Stephenson
666 * Josh Stompro
667 * Dan Wells
668
669
670 2.12.0 Upgrade notes
671 --------------------
672 Evergreen 2.12 now requires OpenSRF 2.5 or later; certain functionality
673 will not work if you attempt to run Evergreen 2.12 on OpenSRF 2.4. Evergreen
674 2.12 recommends PostgreSQL 9.4. The minimum supported version of PostgreSQL is
675 9.3.
676
677 The stock schema upgrade script performs a browse and facet reingest,
678 recalculates bib fingerprints, and remaps metarecords.
679
680 This version also adds two new services, `open-ils.ebook_api` and
681 `open-ils.hold-targeter`.
682
683 2.12.0 New Features
684 -------------------
685
686 Acquisitions
687 ~~~~~~~~~~~~
688 Default status for received line items
689 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
690 A new Library Setting has been added to allow libraries to set the default
691 status for received line items. The previous behavior was to use the
692 "In process" status for all acquisitions items that are received.
693
694
695 Administration
696 ~~~~~~~~~~~~~~
697
698
699
700 Additional SMS Carriers
701 ^^^^^^^^^^^^^^^^^^^^^^^
702 SMS carrier definitions are now included for Google Fi and
703 Republic Wireless. These will be automatically loaded when
704 installing a new Evergreen system; admins who wish to
705 add these definitions during an upgrade can use the following
706 email gateway values:
707
708  * Google Fi: `$number@msg.fi.google.com`
709  * Republic Wireless: `$number@text.republicwireless.com`
710
711
712
713
714 Bibliographic Fingerprint Improvements
715 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
716 The bibliographic fingerprint will now incorporate subfields $n and $p from MARC
717 title fields to better distinguish among records of the same series that
718 may share the same title but have a different part. With this change, these
719 MARC records will no longer be grouped together in a 'Group Formats & Editions'
720 search.
721
722 The bibliographic fingerprint was also changed to better distinguish among
723 the fields contributing to the fingerprint. This change will help the system
724 distinguish between a record for the movie _Blue Steel_ and another record for
725 the book _Blue_ written by Danielle Steel.
726
727
728
729
730
731
732 Batch Hold Targeter Speed-up and New Features
733 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
734
735 Adds a new `open-ils.hold-targeter` service, supporting new targeting options
736 and runtime optimizations to speed up targeting.  The service is launched
737 from a new targeting script, `hold_targeter_v2.pl` (default location:
738 `/openils/bin/hold_targeter_v2.pl`).
739
740 This code has no effect on the existing hold targeter, which is still
741 available as of this release and functions as before.
742
743 New Features/Options
744 ++++++++++++++++++++
745
746 * Adds a global configuration flag 'circ.holds.retarget_interval' for 
747   setting the hold retarget interval.
748
749 * `--target-all` option forces the targeter to process all active
750   holds, regardless of when they were last targeted.
751
752 * `--retarget-interval` option make is possible to override the new
753   'circ.holds.retarget_interval' setting via the command line 
754   when calling the hold targeter.
755
756 * `--skip-viable` option causes the hold targeter to avoid modifying 
757   the currently targeted copy (i.e. the copy on the pull list) for holds 
758   that target a viable (capturable) copy.  
759   {empty} +
760   {empty} +
761   For skipped holds, no entry is added to the unfulfilled_hold_list.
762   The set of potential copies (hold copy maps) are refreshed for all
763   processed holds, regardless of target viability.
764   {empty} +
765   {empty} +
766   This option is useful for 1.) finding targets for holds that require 
767   new targets and 2.) adding new/modified copies to the potential copy 
768   lists (for opportunistic capture) more frequently than you may want to do full
769   retargeting of all holds.
770
771 * `--newest-first` option processes holds in reverse order of request_time,
772   so that newer holds are (re)targeted first.  This is primarily useful
773   when a large backlog of old, un-targetable holds exist.  With 
774   `--newest-first`, the older holds will be processed last.
775
776 * `--parallel` option overrides the parallel settings found in `opensrf.xml`
777   for simpler modification and testing.
778
779 * `--lockfile` option allows the caller to specify a lock file instead
780   of using the default /tmp/hold_targeter-LOCK
781
782 * `--verbose` option prints progress info to STDOUT, showing the number of
783   holds processed per parallel targeter instance.
784
785 * When configured, hold target loops cycle through all org units (with 
786   targetable copies) instead of repeatedly targeting copies at the pickup
787   library when multiple targetable copies exist at the pickup library.
788
789 * When configured, hold target loops prioritize (targetable) org units
790   first by the number of previous target attempts, then by their 
791   weight/proximity.  This effectively back-fills org units that had no
792   targetable copies during earlier target loops so that they are 
793   targeted as many times as other org units (to the extent possible, 
794   anyway).
795
796 Examples
797 ++++++++
798
799 * Traditional daily hold targeter with a value set for 
800   'circ.holds.retarget_interval'.
801
802 [source,sh]
803 --------------------------------------------------------------------------
804 /openils/bin/hold_targeter_v2.pl
805 --------------------------------------------------------------------------
806
807 * (Re)target non-viable holds twice a day, only processing holds that 
808   have never been targeter or those that have not been re-targeted in
809   the last 12 hours.
810
811 [source,sh]
812 --------------------------------------------------------------------------
813 /openils/bin/hold_targeter_v2.pl --skip-viable --retarget-interval "12h"
814 --------------------------------------------------------------------------
815
816 * (Re)target non-viable holds twice a day, processing all holds regardless
817   of when or if they were targeted before, running 3 targeters in
818   parallel.
819
820 [source,sh]
821 --------------------------------------------------------------------------
822 /openils/bin/hold_targeter_v2.pl --skip-viable --target-all --parallel 3
823 --------------------------------------------------------------------------
824
825
826
827
828
829 Add separate make target for translators
830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
831 For those only interested in building Evergreen translations, a separate
832 "translator" make target has been added to allow for easier installation
833 of i18n prerequisites.
834
835
836 Allow admin to specify where Perl modules will be installed
837 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
838 Add `--with-perlbase` option to `configure` to specify an alternative
839 location for installing the Perl modules. This can be useful for setups
840 that want to run the Perl modules from a shared filesystem or
841 environments that need to run multiple versions of Evergreen
842 simultaneously.
843
844 Users of `--with-perlbase` are responsible for ensuring that `PERL5LIB`
845 is set appropriately.
846
847
848
849 Addition of missing permissions
850 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
851 Required permissions that were previously missing from the stock data have now
852 been added. If Evergreen sites have already manually added these permissions,
853 the upgrade script will remove the old permission and create the new one,
854 maintaining any maps to permission groups, with the stock permission ID.
855
856
857
858
859
860 get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers
861 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
862 In action trigger templates it's now possible to call
863 `helpers.get_org_unit_ancestor_at_depth($id_or_aou, $depth)` in order to retrieve
864 a fleshed aou for the target aou's ancestor at the chosen depth. This could be
865 used to retrieve the name of the library system rather than a specific branch
866 name, for instance.
867
868
869
870
871 Removed unused selfcheck password setting
872 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
873 There was an unused duplicate selfcheck password setting that was removed
874 to avoid confusion over which library setting was supposed to be set to
875 enable passwords for selfcheck. After upgrading, verify that your library
876 policy remains consistent for this setting.
877
878
879
880
881
882 Credit Processor Stripe Settings Permissions
883 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
884 Unprivileged users can retrieve organizational unit setting values for
885 setting types lacking a "view" permission.  When the feature adding
886 Stripe credit card processing was added, the upgrade script neglected
887 to add the VIEW_CREDIT_CARD_PROCESSING permission to the
888 organizational unit setting type.  This means that anyone can retrieve
889 and view the settings for Stripe credit card processing.
890
891 Any system that upgraded from Evergreen version 2.5 to 2.6 is
892 affected.  If you use Stripe for credit card processing, it is
893 strongly recommended that you apply this upgrade.  Even if you do not
894 use Stripe, applying this upgrade is still recommended.  If you did
895 not upgrade from version 2.5 to 2.6 of Evergreen, but started with a
896 later version, applying this upgrade is harmless.
897
898
899
900
901 Cataloging
902 ~~~~~~~~~~
903
904
905
906 New Access Points for MARC Merge/Overlay Profiles
907 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
908 Catalogers can now select a MARC merge/overlay profile to apply when
909 merging records in the (browser client) record bucket merge and Z39.50
910 record overlay interfaces. In both interfaces, if the user selects
911 a merge profile, the results of the merge are displayed, giving the
912 user the opportunity to choose a different merge profile or edit
913 the records involved prior to committing to the merge.
914
915 A new library setting, "Default Merge Profile (Z39.50 and Record Buckets)",
916 specifies the merge profile to preselect in the new merge profile
917 selectors in the record bucket merge and Z39.50 overlay logs. The
918 selectors will also remember the last selection that the user made.
919
920
921
922
923 Circulation
924 ~~~~~~~~~~~
925
926
927
928 Display Copy Alerts With In-House-Use
929 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
930
931 Two library settings are used to control the display of copy alert
932 messages or copy location check in alerts when recording in-house-use
933 in Evergreen.
934
935 Setting 'Display copy alert for in-house-use' to true for an
936 organization will cause an alert to appear with the copy's alert
937 message, if it has one, when recording in-house-use for the copy.
938
939 Setting 'Display copy location check in alert for in-house-use' to true
940 for an organization will cause an alert to display a message
941 indicating that the item needs to be routed to its location if the
942 location has check in alert set to true.
943
944 The settings are independent of one another because you may want to
945 display one and not the other when recording in-house-use.
946
947
948
949
950 Client
951 ~~~~~~
952
953
954
955 Active Date Column Picker Option
956 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
957 The active date will now be available as a column picker option in the Item
958 Status screen.
959
960
961
962
963 Punctuation Insensitive Patron Search
964 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
965 When performing a patron search, punctuation characters will be
966 ignored.  So if the patron is named O'Brien, then you can enter Obrien,
967 O'Brien, O Brien, etc. in the search box.
968
969 This behavior affects the Last Name (internally: family_name), First Name
970 (first_given_name), and Middle Name (second_given_name) fields of the search.
971
972
973
974
975
976
977 Touch screen improvements for Evergreen self-check interface
978 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
979 Improvements were made to the Evergreen self-check interface to make it easier
980 to use in a touch-screen environment.
981
982  * The pay fines link is now a pay fines button, matching other buttons on the
983 page.
984  * The checkboxes have been enlarged, making them easier to activate when using
985 a touch screen.
986
987
988
989
990
991 Trial Production Use of the Web Staff Client
992 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
993 The new web staff client is ready for trial production use in all functional
994 areas with the exception of serials and offline transactions. In addition to
995 many bug fixes in the areas of circulation, cataloging, administration and
996 reporting, Release 2.12 sees the following additions to web client
997 functionality.
998
999  * Acquisitions interfaces and functionality have been integrated into the web
1000  staff client.
1001  * Booking interfaces and functionality have been integrated into the web staff
1002  client.
1003  * Hatch, the program that will allow for unmediated printing to multiple
1004  printers, sharing of workstation settings, and, eventually, offline 
1005  transactions is now available. A windows installer for Hatch will be available
1006  on the Evergreen-ILS Downloads page.
1007
1008 The Evergreen developers will keep pilot libraries updated about known web
1009 client issues by posting known bugs to https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:known_issues .
1010
1011 About Hatch
1012 +++++++++++
1013 Hatch is not required to use the web client, but should be used for workstations
1014 that need to perform the following tasks.
1015
1016  * Unmediated printing to multiple printers. Workstations can print to multiple
1017  printers without Hatch, but will need to click through a dialog to select a
1018  printer. Hatch allows workstations to automatically print, without dialog, to
1019  different printers. 
1020  * Storage of workstation settings in a place outside the browser. Storing local
1021  preferences in hatch will prevent tampering with preferences via the browser
1022  developer tools and protect the settings from possible deletion if the browser
1023  deletes settings in local storage.
1024  * When offline functionality is available, hatch will be required to perform
1025  offline transactions.
1026  
1027 Hatch is currently run as a Chrome extension and is not available in Firefox. To
1028 use hatch on Windows, Evergreen sites should:
1029
1030  . install a java runtime environment version 8 (or higher) if not already
1031  installed,
1032  . download and execute the installer from the Evergreen downloads page, 
1033  . open Chrome and navigate to chrome://extensions,
1034  . enable _Developer Mode_ along the top right of the page,
1035  . click the _Load Unpacked Extension_ button,
1036  . load the directory at Hatch -> extension -> app,
1037  .. In Windows, the default location for the app directory will be
1038  C:\Program Files (x86)\Hatch\extension\app
1039  . enable hatch features in the web client by going to Administration ->
1040  Workstation Administration -> Print/Storage Service ("Hatch") and choosing
1041  which services to use with Hatch.
1042  .. this page will also inform you that hatch is connected. 
1043
1044
1045
1046
1047 Infrastructure
1048 ~~~~~~~~~~~~~~
1049
1050
1051
1052 Client Timezone Awareness
1053 ^^^^^^^^^^^^^^^^^^^^^^^^^
1054
1055 Previously, adjusting the time zone in which a database session operates
1056 could not be done in any way except globally, directly within the database.
1057 However, allowing modification of the timezone parameter now supports
1058 localization efforts for those consortia that span multiple time zones.
1059
1060 Implementation
1061 ++++++++++++++
1062
1063 CStore and other services that interact with the primary Evergreen database
1064 make use of the functionality provided by LP#1485371 in OpenSRF in order to
1065 set the time zone configuration parameter available in PostgreSQL.  This has
1066 the effect of interpreting all timestamps written to or read from the database
1067 in the client's time zone.
1068
1069 Within CStore (and related, C-based services), all stateful sessions make use
1070 of this capability, setting the database time zone upon a successful CONNECT
1071 message from the client.  The time zone is reset to the database default when
1072 a session is terminated either due to client DISCONNECT or server keepalive
1073 timeout.
1074
1075 All stateless requests record the current database time zone, set the database
1076 time zone to that of the client's, run the query, and then reset the database
1077 time zone on each request that carries a client time zone value.  It is expected
1078 that this will not cause any noticeable increase in latency or query execution
1079 time, as this setting is local to the specific PostgreSQL server backend process.
1080
1081 Within the Storage service, the timezone will be set automatically by a simple
1082 wrapper method used by the existing method registration mechanism for method
1083 publishing.  Disconnect and error callbacks are registered to revert the time
1084 zone setting within the database.  This provides completely transparent time
1085 zone manipulation for backend services that make use of open-ils.storage.
1086
1087
1088
1089
1090 Public Catalog
1091 ~~~~~~~~~~~~~~
1092
1093
1094
1095 New Subject Browse Index Definitions
1096 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1097 New subject browse index definitions have been added that display the entire
1098 heading as a unit with hyphens between terms instead of displaying individual
1099 terms separately. 
1100
1101 For example, the browse heading for:
1102
1103 =650 \0$aCats$zUnited States$vCorrespondence.
1104
1105 will display in a single entry as:
1106
1107 Cats -- United States -- Correspondence
1108
1109 Rather than separate entries for Cats and United States. 
1110
1111 Name subjects will continue to display as separate entries because additional
1112 work would be required for the heading to be punctuated correctly.
1113
1114
1115
1116
1117 Advanced Search Limiters Enhancement
1118 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1119 Advanced search limiters will no longer propagate to the basic search box in
1120 the catalog. Instead, the limiters applied to the search will appear underneath
1121 the search box where they can be easily cleared by clicking an 'x.' On a small,
1122 mobile device, the advanced search limiters can be seen by clicking an 'x filter
1123 applied' link. 
1124
1125 The selected limiters will be applied to any search from the search bar until:
1126  * The user actively removes the filters from the search or
1127  * The user starts a new basic or advanced search from scratch.
1128
1129
1130
1131
1132 Arabic and Right-to-Left Language Support for the catalog
1133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1134 New stylesheets and other changes to the catalog to allow for 
1135 better support of right-to-left (RTL) languages, such as Arabic.
1136
1137 Also adds Arabic (Jordan) as a new supported language.
1138
1139
1140
1141
1142 Ebook API integration
1143 ^^^^^^^^^^^^^^^^^^^^^
1144 Evergreen 2.12 supports partial integration with third-party APIs
1145 provided by OverDrive and OneClickdigital.  When ebook API integration
1146 is enabled, bibliographic records from these vendors that appear in your
1147 public catalog will include vendor holdings and availability information.  Also,
1148 when a user is logged in, the public catalog dashboard and My Account interface
1149 will include information about that user's checkouts and holds for
1150 supported vendors.
1151
1152 For API integration to work, you need to request API access from the
1153 vendor and configure your Evergreen system according to the instructions
1154 below.  You also need to configure the new `open-ils.ebook_api` service.
1155
1156 This feature assumes that you are importing MARC records supplied by the
1157 vendor into your Evergreen system, using Vandelay or some other MARC
1158 import method.  This feature does not search the vendor's online
1159 collections or automatically import vendor records into your system; it
1160 merely augments records that are already in Evergreen.
1161
1162 A future Evergreen release will add the ability for users to check out
1163 titles, place holds, etc., directly via the public catalog.
1164
1165 Ebook API service configuration
1166 +++++++++++++++++++++++++++++++
1167 This feature uses the new `open-ils.ebook_api` OpenSRF service.  This
1168 service must be configured in your `opensrf.xml` and `opensrf_core.xml`
1169 config files for ebook API integration to work.  See
1170 `opensrf.xml.example` and `opensrf_core.xml.example` for guidance.
1171
1172 OverDrive API integration
1173 +++++++++++++++++++++++++
1174 Before enabling OverDrive API integration, you will need to request API
1175 access from OverDrive.  OverDrive will provide the values to be used for
1176 the following new org unit settings:
1177
1178   * *OverDrive Basic Token*: The basic token used for API client
1179     authentication.  To generate your basic token, combine your client
1180     key and client secret provided by OverDrive into a single string
1181     ("key:secret"), and then base64-encode that string.  On Linux, you
1182     can use the following command: `echo -n "key:secret" | base64 -`
1183   * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your
1184     OverDrive API account.
1185   * *OverDrive Website ID*: The website ID for your OverDrive API
1186     account.
1187   * *OverDrive Authorization Name*: The authorization name (a.k.a.
1188     library name) designated by OverDrive for your library.  If your
1189     OverDrive subscription includes multiple Evergreen libraries, you
1190     will need to add a separate value for this setting for each
1191     participating library.
1192   * *OverDrive Password Required*: If your library's OverDrive
1193     subscription requires the patron's PIN (password) to be provided
1194     during patron authentication, set this setting to "true."  If you do
1195     not require the patron's PIN for OverDrive authentication, set this
1196     setting to "false."  (If set to "true," the password entered by a
1197     patron when logging into the public catalog will be cached in plain text in
1198     memcached.)
1199   * *OverDrive Discovery API Base URI* and *OverDrive Circulation API
1200     Base URI*: By default, Evergreen uses OverDrive's production API, so
1201     you should not need to set a value for these settings.  If you want
1202     to use OverDrive's integration environment, you will need to add the
1203     appropriate base URIs for the discovery and circulation APIs.  See
1204     OverDrive's developer documentation for details.
1205   * *OverDrive Granted Authorization Redirect URI*: Evergreen does not
1206     currently support granted authorization with OverDrive, so this
1207     setting is not currently in use.
1208
1209 For more information, consult the
1210 https://developer.overdrive.com/docs/getting-started[OverDrive API
1211 documentation].
1212
1213 To enable OverDrive API integration, adjust the following public catalog settings
1214 in `config.tt2`:
1215
1216   * `ebook_api.enabled`: set to "true".
1217   * `ebook_api.overdrive.enabled`: set to "true".
1218   * `ebook_api.overdrive.base_uris`: list of regular expressions
1219     matching OverDrive URLs found in the 856$9 field of older OverDrive
1220     MARC records.  As of fall 2016, OverDrive's URL format has changed,
1221     and the record identifier is now found in the 037$a field of their
1222     MARC records, with "OverDrive" in 037$b.  Evergreen will check the
1223     037 field for OverDrive record identifiers; if your system includes
1224     older-style OverDrive records with the record identifier embedded in
1225     the 856 URL, you need to specify URL patterns with this setting.
1226
1227 OneClickdigital API integration
1228 +++++++++++++++++++++++++++++++
1229 Before enabling OneClickdigital API integration, you will need to
1230 request API access from OneClickdigital.  OneClickdigital will provide
1231 the values to be used for the following new org unit settings:
1232
1233   * *OneClickdigital Library ID*: The identifier assigned to your
1234     library by OneClickdigital.
1235   * *OneClickdigital Basic Token*: Your client authentication token,
1236     supplied by OneClickdigital when you request access to their API.
1237
1238 For more information, consult the
1239 http://developer.oneclickdigital.us/[OneClickdigital API documentation].
1240
1241 To enable OneClickdigital API integration, adjust the following public catalog
1242 settings in `config.tt2`:
1243
1244   * `ebook_api.enabled`: set to "true".
1245   * `ebook_api.oneclickdigital.enabled`: set to "true".
1246   * `ebook_api.oneclickdigital.base_uris`: list of regular expressions
1247     matching OneClickdigital URLs found in the 859$9 field of your MARC
1248     records.  Evergreen uses the patterns specified here to extract
1249     record identifiers for OneClickdigital titles.
1250
1251 Additional configuration
1252 ++++++++++++++++++++++++
1253 Evergreen communicates with third-party vendor APIs using the new
1254 `OpenILS::Utils::HTTPClient` module.  This module is configured using
1255 settings in `opensrf.xml`.  The default settings should work for most
1256 environments by default, but you may need to specify a custom location
1257 for the CA certificates installed on your server.  You can also disable
1258 SSL certificate verification on HTTPClient requests altogether, but
1259 doing so is emphatically discouraged.
1260
1261
1262
1263 Links to Other Formats and Editions
1264 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1265 The record summary pages in the catalog will now link to other formats and
1266 editions of a title. The links will allow users to quickly jump to another
1267 format of the title or an edition written in another language. 
1268
1269
1270
1271
1272
1273 Metarecord Search Improvements
1274 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1275 This release brings several improvement to the Group Formats and Editions
1276 search. 
1277
1278  * Limiters on the advanced search page can now be successfully applied to 
1279 Group Formats and Editions searches,
1280  * Electronic resources are now retrievable through these searches,
1281  * Paged navigation has improved.
1282
1283
1284
1285
1286 Allow Metarecord Search by default
1287 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1288 Before the TPAC, a site could configure the public catalog to use metarecord searching
1289 by default, via a configuration file.  Here we bring that back.
1290
1291 A new setting called search.metarecord_default is present in
1292 `templates/opac/parts/config.tt2` to enable this feature.  By setting this to
1293 a true value (normally 1) the TPAC will silently include the #metabib search
1294 modifier in the search form on any interfaces that do not have a UI component
1295 that allows the user to control the setting.
1296
1297
1298
1299 RDA Improvements
1300 ^^^^^^^^^^^^^^^^
1301  * Author fields are now normalized to strip ending periods so that authors from
1302 RDA and non-RDA records are collapsed in browse and facet headings.
1303  * All author/contributor roles will now display in the record detail page.
1304 Previously, some of the roles were omitted or were duplicated.
1305
1306
1307 Obalkyknih.cz Integration
1308 ^^^^^^^^^^^^^^^^^^^^^^^^^
1309 Evergreen now integrates with Czech added content provider obalkyknih.cz. A new
1310 setting called obalkyknih_cz.enabled is available in
1311 `templates/opac/parts/config.tt2` to enable this new feature.
1312
1313
1314 2.12.0 Acknowledgments
1315 ----------------------
1316 The Evergreen project would like to acknowledge the following
1317 organizations that commissioned developments in this release of
1318 Evergreen:
1319
1320 * Bibliomation
1321 * British Columbia Libraries Cooperative
1322 * C/W MARS
1323 * Georgia PINES
1324 * King County Library System
1325 * Linn Libraries Consortium
1326 * MassLNC
1327 * Pennsylvania Integrated Library System
1328 * Pioneer Library System
1329
1330 We would also like to thank the following individuals who contributed
1331 code, translations, documentations patches and tests to this release of
1332 Evergreen:
1333
1334 * Adam Bowling
1335 * Anahi Valdez
1336 * Ben Shum
1337 * Bill Erickson
1338 * Billy Horn
1339 * Blake Henderson
1340 * Bob Wicksall
1341 * Chris Sharp
1342 * Christine Burns
1343 * Christine Morgan
1344 * Clare Sobotka
1345 * Dan Pearl
1346 * Dan Scott
1347 * Dan Wells
1348 * Darrell Rodgers
1349 * Debbie Luchenbill
1350 * Eva Cerninakova
1351 * Fares Othman
1352 * Galen Charlton
1353 * Jakub Kotrla
1354 * Jane Sandberg
1355 * Jason Boyer
1356 * Jason Etheridge
1357 * Jason Stephenson
1358 * Jeanette Lundgren
1359 * Jeff Davis
1360 * Jeff Godin
1361 * Jennifer Pringle
1362 * Jillianne Presley
1363 * Jim Keenan
1364 * Job Diógenes Ribeiro Borges
1365 * Jonathan Schatz
1366 * Josh Stompro
1367 * Kate Butler
1368 * Kathy Lussier
1369 * Kyle Huckins
1370 * Linda Jansová 
1371 * Michele Morgan
1372 * Michelle Purcell
1373 * Mike Rylander
1374 * Nawras Othman
1375 * Remington Steed
1376 * Rogan Hamby
1377 * Terran McCanna
1378 * Thomas Berezansky
1379 * Victoria Lewis
1380
1381 We also thank the following organizations whose employees contributed
1382 patches:
1383
1384 * British Columbia Libraries Cooperative
1385 * Calvin College
1386 * Catalyst DevWorks
1387 * C/W MARS
1388 * Emerald Data Networks, Inc.
1389 * Equinox Open Library Initiative
1390 * Georgia PINES
1391 * Indiana State Library
1392 * The Institute for the Study of Totalitarian Regimes, Prague
1393 * Jabok Library
1394 * Jordanian Library and Information Association
1395 * King County Library System
1396 * Lake Agassiz Regional Library
1397 * Laurentian University
1398 * Linn-Benton Community College
1399 * MassLNC
1400 * Merrimack Valley Library Consortium
1401 * MOBIUS Consortium
1402 * North of Boston Library Exchange
1403 * Pioneer Library System
1404 * Rodgers Memorial Library
1405 * Sigio
1406 * Traverse Area District Library
1407
1408
1409 We regret any omissions.  If a contributor has been inadvertently
1410 missed, please open a bug at https://bugs.launchpad.net/evergreen/
1411 with a correction.
1412