1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes for regressions in Evergreen 3.0.12.
9 All bug fixes refer to the web staff client unless otherwise specified.
14 * Removes the tooltip feature when you mouse over a grid cell because this feature degraded performance.
15 * Fixes an issue with adding two or more copies in cataloging.
16 * Fixes the inability to add copies from Item Status and Holdings View.
20 We would like to thank the following individuals who contributed code,
21 tests and documentation patches to the 3.0.13 point release of
29 This release contains bug fixes improving on Evergreen 3.0.11.
30 All bug fixes refer to the web staff client unless otherwise specified.
35 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
36 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
37 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
38 * Fixes various misspellings and capitalization issues in the interface.
39 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
40 * Fixes an issue with checking in hourly loans.
41 * Staff can now approve pending patron addresses in the patron edit interface.
42 * Prevents patron records from being merged with themselves.
43 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
44 * Fixes issues with duplicate transit records.
45 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
46 * Improvements to the Item Attribute Editor.
47 * Staff can now set a default search box in the Z39.50 search interface.
48 * Staff can now delete copy notes.
49 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
50 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
51 * Protects backordered acquisitions items from having their catalog items deleted.
52 * Fixes problems that occur when cloning a report template created in the XUL client.
53 * Fixes bugs that caused activity metric data when performing searches.
54 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern.
55 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
59 We would like to thank the following individuals who contributed code,
60 tests and documentation patches to the 3.0.12 point release of
89 This release contains bug fixes improving on Evergreen 3.0.10.
90 All bug fixes refer to the web staff client unless otherwise specified.
95 * Several strings are now displayed in the correct translation.
96 * Right clicking in grids results in more intuitive behavior.
97 * Usernames and barcodes containging the _%_ character no longer
98 experience problems logging in.
99 * Fixes cases in which the web client stops loading after the toolbar.
100 * Fixes problems in which using the web client in multiple tabs leads
101 to data inconsistency.
102 * Fixes an issue that caused authentication session checks to spam
103 the system and needlessly fill up logs.
104 * Boolean fields within grid views now say "Yes"/"No" instead of
106 * Fixes sorting issues in the patron search.
107 * Staff can now choose to print out only a selection of items out,
108 instead of having to print them all.
109 * The patron triggered event screen now respects the
110 `circ.staff.max_visible_event_age` library setting.
111 * Fixes an issue which caused an exception to be thrown during
112 non-cataloged item checkout.
113 * Fixes permission issues related to merging users.
114 * The bibliographic record summary now displays the call number that
115 matches the library's classification system.
116 * The copy editor now makes shelving locations visible to catalogers
117 from other libraries as needed.
118 * Once a record is overlayed in the Z39.50 screen, it is no longer
120 * Several fixes to the filters on the Holdings View screen.
121 * Several fixes to how empty volumes are created and displayed.
122 * Fixes to item and call number transfers.
123 * Fixes several issues with the item status list view.
124 * When adding new copies, the circulation library now defaults to the
125 call number's owning library.
126 * Fixes display issues with the Print Item Labels page.
127 * Fixes an issue in which the staff client and the OPAC displayed
128 different counts of available items.
132 We would like to thank the following individuals who contributed code,
133 tests and documentation patches to the 3.0.11 point release of
153 This release contains bug fixes improving on Evergreen 3.0.9. Note that
154 all bug fixes refer to the web staff client unless otherwise specified.
159 * Fixes right-click issues with the Web client grids
160 * Fixes an issue with the Default SMS Carrier in the patron edit form.
161 * Fixes an issue that allowed overdue notices to be sent to a patron
162 whose long overdue item has been paid for.
163 * Checking in precat items now displays the "Route to Cataloging" alert each
164 time the item is checked in.
165 * Fixes an issue in which the Adjust to Zero feature
166 does not close a checked-in lost circ.
167 * Deleted copies that are still checked out can now be checked in.
168 * Fixes a mislabeled column in the patron checkout grid.
169 * Fixes an error with the missing pieces functionality.
170 * Courier codes now display in the transit slip receipt preview.
171 * The Item Status grid now displays OU shortnames instead of full names
172 for the "Circulation Library" column.
173 * The Volume/Copy editor now allows users to remove a value from the Age
174 Hold Protection field.
175 * Barcode completion now works in copy buckets.
176 * The Z39.50 interface now notices when another record has been marked
178 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
179 the Z39.50 interface.
180 * Fixes a performance issue for the Validate button in the MARC Editor.
181 * Fixes an incorrect close tag in the Print Item Labels toolbar.
182 * Better scoping of copy tags in search results.
183 * Electronic Resource links now open in a new tab.
184 * Fixes an issue with the fiscal year close-out operation.
185 * Improves serials item deletes.
189 We would like to thank the following individuals who contributed code,
190 tests and documentation patches to the 3.0.10 point release of
215 This release contains bug fixes improving on Evergreen 3.0.8. Note that
216 all bug fixes refer to the web staff client unless otherwise specified.
221 * Fixes specific cases in which deleted records appear in search results.
222 * Fixes a performance issue with deleting patrons.
223 * The hold shelf dialog popup now lists the patron's notification
225 * Fixes an issue that prevented editing items when a monograph part
227 * Patron information is now available for use in the bills_current
228 and bills_historical receipt templates.
229 * The browser's "This page may contain unsaved data" warning now
230 appears when users click the update
231 expire date button in a patron account and attempt to navigate away
233 * The holds tab of the patron record now includes a monograph part
235 * The barcode box in the checkout screen
236 no longer hovers above patron record tabs when
237 staff users scroll down.
238 * Fixes an issue with the date of birth in the patron edit scren.
239 * Fixes an issue with the dropdown of billing type options.
240 * The Item Status screen now includes as a floating group column.
244 We would like to thank the following individuals who contributed code,
245 tests and documentation patches to the 3.0.9 point release of
248 * BC Libraries Cooperative
254 * Blake Graham-Henderson
271 This release contains bug fixes improving on Evergreen 3.0.7. Note that
272 all bug fixes refer to the web staff client unless otherwise specified.
280 * The MARC editor now handles 008 fields better.
281 * Adds spaces between subfields when suggesting a call
282 number for a new volume.
283 * MarcXML exports from the MARC Batch Import/Export ->
284 Export Records screen now downloads the file, rather than opening
286 * The Item Status Circulation Library column now displays a
287 shortname rather than the full library name.
288 * The Item Status Remaining Renewals column now displays
290 * The Item Status now has a "Last Renewal Workstation" column
292 * Fixes the circulation counts displayed in Item Status Details.
293 * Fixes an issue where multiple copies with different values for required
294 statistical categories could not be edited and saved in batch.
295 * Add an option to remove floating in the copy editor.
296 * Fixes an issue with the floating dropdown in the copy editor.
297 * Fixes a problem in which the copy template didn't properly copy
299 * Reduces the number of API calls that the MARC Editor requires.
304 * Fixes an issue that prevented the offline patron registration
306 * Fixes an issue with searching patrons by permission group.
307 * The barcodes in the patron search are now clickable.
308 * Staff members can now manually override the patron juvenile
309 flag value, regardless of the patron's date of birth.
310 * Checkboxes on patron registration screen are now properly aligned
312 * The user permission group dropdowns in the patron registration,
313 edit, and search interfaces now have scrollbars.
314 * The date picker on the checkout screen is now hidden unless
315 circ staff activates a specific due date option.
316 * The check-in screen now includes a copy status column.
317 * The Merge Patrons interface now displays the date of birth.
318 * The user bucket screen now displays the Bucket ID.
319 * The payment button on patron bills screen is now inactive if the
320 Payment Received field is blank.
321 * The Bill History receipt now includes a Finish date and a Last
323 * When a patron summary contains an image of the patron,
324 that image tag now has a null alt attribute to remove it from
325 the flow of a screen reader.
326 * Corrects an issue that caused the transit dialog to show the
328 * Corrects an issue with printing transit lists.
329 * "Find another target" on transiting hold no longer leaves the
331 * The images now display to distinguish hold and transit slips.
332 * The Clearable Holds list printout now only shows holds that have
334 * Restores the call number prefix and suffix fields to the holds
336 * The documentation at the top of the hold shelf slip template
338 * The cursor in the in-house use screen now automatically goes
339 to the barcode field.
340 * The in-house use screen now shows a copy status column.
341 * Add support for converting change to patron credit in the patron bills
342 interface, consistent with the XUL feature.
343 * Fixes a bug that caused pickup/request library fields to be
345 * Fixes a bug in the offline org unit tree.
347 Command-line system administration
348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
350 * The novelist entry in `eg_vhost.conf` includes two new
352 * Corrects an issue with the `--max-sleep` argument on the
353 `action_trigger_runner.pl` support script.
354 * Corrects an issue with how the `eg_pbx_allocator.pl` script
355 detects an existing lock file.
356 * The 3.0.2-3.0.3 upgrade script disables triggers before
357 recalculating bib visibility.
362 * Fixes an issue that caused records with located URIs to be
363 retrieved in Copy Location and Copy Location Group searches.
364 * Fixes an error message that appeared in the search box
365 in the public catalog while placing hold after an advanced search.
366 * Restores the display of copy information for the user's
367 preferred library in the public catalog.
368 * Fixes regression errors in the search results page.
369 * Removes redundant call numbers from the Show More Details
371 * The cast field in the catalog is now taken from the 511 field
372 when first indicator = 1, rather than the 508.
373 * Fixes a display issue caused by editing holds.
378 * Fixes an issue that prevented users from searching for
379 receivable issues using Database ID or ISSN in the Serials
380 Batch Receive interface.
385 * Adds some padding to the bottom of Web Client interfaces.
386 * Logins now honor all org unit timeout settings.
387 * Evergreen will now identify and handle invalid timezones.
388 * Fixes an issue where a column header in some interfaces were automatically
389 highlighted in green when retrieving the interface.
390 * The parts column in the Item Status screen now displays parts data.
396 We would like to thank the following individuals who contributed code,
397 tests and documentation patches to the 3.0.8 point release of
432 This release contains bug fixes improving on Evergreen 3.0.6.
434 * Fixes a performance issue with the Patron Billing History screen and
435 other screens that cause Flattener.pm to re-create joins
437 * Fixes an issue that prevented patron alerts from showing to staff at
439 * Corrects the "Holdable" attribute display on the Item Status detailed
441 * Fixes the ability to delete multiple copies from Item Status.
445 We would like to thank the following individuals who contributed code,
446 tests and documentation patches to the 3.0.7 point release of
460 This release is a security release that fixes cross-site scripting
461 (XSS) vulnerabilities in the Evergreen public catalog. This release
462 also includes several other bugfixes improving on Evergreen 3.0.5.
464 Security Issue: XSS Vulnerability in Public Catalog
465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
466 This release fixes several cross-site scripting (XSS) vulnerabilities
467 in the public catalog. When upgrading, Evergreen administrators should
468 review whether any of the following templates have been customized
469 or overridden. If so, either the template should be replaced with the
470 stock version or the XSS fix (which entails adding the `| html` filter
471 in several places) applied to the customized version.
473 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
474 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
475 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
477 Note that exploiting the XSS vulnerabilities fixed in this release
478 would require either the ability to create maliciously-constructed
479 MARC bibliographic or holdings records or the ability to set a
480 maliciously constructed organizational unit name.
484 Evergreen 3.0.6 also includes the following changes:
486 * When using 'Selection Lists -> Edit MARC Order Record' in the web
487 staff client, now only one click is required to save the MARC
488 record rather than two.
489 * The volume/copy editor in the web staff client now better handles
490 editing multiple items that have different sets of statistical
491 category values assigned to them.
492 * The act of merging bibliographic records now updates bookbags
493 that referred to the source bibliographic record rather than
494 effectively deleting entries for that record.
495 * Additional columns were added to the Holds Pull List in the
497 * The patron registration form in the web staff client now correctly
498 manages setting user preferences.
499 * An error in a pgTAP unit test was corrected.
503 We would like to thank the following individuals who contributed code,
504 tests and documentation patches to the 3.0.6 security release of
520 This release contains bug fixes improving on Evergreen 3.0.4.
522 * The MARC Editor in the Web staff client now wraps long fields.
523 * The MARC Editor no longer allows catalogers to enter new lines
525 * Fixes an issue that prevented serials items from being deleted or
527 * The Web staff client Check In screen no longer reloads the whole
528 page multiple times each time an item is scanned.
529 * Fixes an issue that displayed the oldest -- rather than the newest
530 -- transit in the Web staff client Item Status page.
531 * Fixes an issue that prevented the reports module from being displayed
533 * Fixes an issue in the Web staff client reports module that caused
534 syntax errors in reports that use virtual fields and joins.
535 * Fixes an issue that prevented several dropdown menus in the Web staff
536 client from activating.
537 * Fixes an issue that created duplicate copy data when copies or
538 volumes with parts were transferred.
539 * Fixes the Trim List feature in the Web staff client Check In screen.
540 * The Item Status grid now displays the Circulation Modifier.
541 * Restores missing data from the Profile column in Place Hold patron
543 * Fixes an issue with the http -> https redirect on Apache 2.4.
544 * Fixes an color contrast accessibility issue in the Web staff
545 client and adds underlining to links in grid cells for added accessibility.
546 * Adds automated regression and unit tests for the Web staff client
548 * Adds a process for spell-checking the official documentation.
549 * Adds a script that simplifies the release process related to translations.
554 We would like to thank the following individuals who contributed code,
555 tests and documentation patches to the 3.0.5 point release of
560 * Blake Graham-Henderson
575 This release contains bug fixes improving on Evergreen 3.0.3:
577 * Fixes a bug that caused all searches limited by shelving location to
579 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
580 rather than the ordering agency's SAN.
581 * Fixes a bug that prevented Safari/iOS users from logging in to the
583 * Fixes a bug that prevented users from using the browse interface.
584 * Fixes a bug in the Item Status List view that caused incorrect due
586 * Approval code is now a required field in the web client's patron
587 credit card payment form.
588 * Fixes a bug with credit card payments that caused a receipt to print
589 showing that the patron paid the bill when the payment had not actually
591 * Fixes a bug that prevented the EDI translator from being installed on
593 * Fixes a bug that caused entries to show up multiple times in the
594 Items Out and Holds tabs in the patron record.
595 * Fixes a bug that caused grids on Bills and Patron Messages
596 screens to not display properly.
597 * The following fields are now available for the Checkout and Items Out
604 ** money_summary.balance_owed
605 ** money_summary.total_paid
606 ** money_summary.total_owed
611 * The following fields are now available on the Bill Payment receipt templates:
621 * Payment type is now a column in the payments tab of the patron record
622 Bill History section.
623 * The "Replace Barcode" function now makes it more difficult for staff
624 members to attempt to create blank patron barcodes.
625 * The patron bills screen now prevents staff members from double-clicking
626 on the Apply Payment button (which otherwise would apply two payments).
627 * Fixes a bug that prevented patrons attached to statistical categories
628 from displaying in the patron search-to-hold dialog.
629 * Fixes a performance issue related to uploading CSV files of barcodes
630 to the item status and patron bucket interfaces.
631 * Fixes several small bugs in the Spanish translation.
632 * Fixes a performance bug related to patrons logging in by barcode.
636 We would like to thank the following individuals who contributed code,
637 tests and documentation patches to the 3.0.4 point release of
659 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
660 update the visibility attributes of all bibs that make use of Located URIs or
661 bib sources. It may take a while to run on large datasets. If it it running
662 too long, it can be canceled and the following psql commands will create and
663 run a script that will perform the same action serially over time without
664 blocking writes to bibs:
667 \o /tmp/luri_visibility_update.sql
668 SELECT 'UPDATE biblio.record_entry SET ' ||
669 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
670 'WHERE id = ' || id || '; SELECT ' || id || ';'
671 FROM biblio.record_entry
673 SELECT DISTINCT cn.record
674 FROM asset.call_number cn
676 AND cn.label = '##URI##'
679 FROM asset.uri_call_number_map m
680 WHERE m.call_number = cn.id
683 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
688 \i /tmp/luri_visibility_update.sql
691 It will output the id of each updated bib so that the script can be killed
692 and then edited to remove completed bibs. The remainder can be run at a
695 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
696 we do NOT update the bib's visibility attributes, as doing so causes a loop
697 and an eventual trigger stack violation. This flag should ONLY be used when
698 forcing reingest of record attributes (NOT visibility attributes), search,
699 facet, and display fields, so if using this flag under normal operation,
700 proceed at your own risk and know that Located URI and bib source changes
701 will not be reflected in the visibility attributes of the record.
705 This release contains several bug fixes improving on Evergreen 3.0.1:
707 * Fixes several issues related to the display of located URIs and records with
708 bib sources in search results.
709 * Setting `opac_visible` to false for a copy location group now hides only
710 the location group itself, rather than also hiding every single copy in the
712 * Fixes a bug that prevented the copy editor from displaying the _fine level_
713 and _loan duration_ fields.
714 * The "Edit Items" grid action in the Item Status interface will now open
715 in the combined volume/copy editor in batch. This makes the behavior
716 consistent with the "Edit Selected Items" grid action in the copy
718 * Staff members are now required to choose a billing type when creating a
719 bill on a user account.
720 * The Web client now provides staff users with an alert and option to
721 override when an item with the Lost and Paid status is checked in.
722 * Fixes a bug where the Web client offline circ interface was not able
723 to set its working location.
724 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
726 * The MARC editor in the Web staff client now presents bib sources in
728 * Both circulation and grocery bills are now printed when a staff user selects
729 a patron account and clicks "Print Bills".
730 * Fixes an issue in the XUL serials interface the "Receive move/selected"
731 action from succeeding.
732 * Fixes a typo in the user password testing interface.
736 We would like to thank the following individuals who contributed code,
737 tests and documentation patches to the 3.0.3 point release of
756 This release contains several bug fixes improving on Evergreen 3.0.1:
758 * Copy templates created in XUL Holdings Maintenance will now be
759 automatically converted and displayed in the web staff client's
761 * The list of report templates now includes a column indicating whether
762 the template was originally created in the XUL staff client or the web
763 staff client; staff need to know this since report templates created in
764 one interface cannot be edited in the other.
765 * Call number prefixes and suffixes are now displayed in various grids
766 in the web staff client, including
767 ** Pending Copy Buckets
769 ** Checkin/Capture Holds
771 ** Patron Bills History
778 ** Bib Record View Holds
780 * Many patron fields have been redacted from the web staff client's patron
781 and record holds grids, leaving patron name, username, and ID.
782 * Fixes two bugs where patron records could fail to be saved upon editing.
783 * The web staff patron editor now better warns staff users about
784 duplicate names, IDs, phone numbers, and email addresses.
785 * Human readable labels are now displayed for certain fields in standing
787 * The patron summary in the web staff client now correctly displays
788 primary and secondary ID values.
789 * The web staff client's billing full details page now displays
790 information about the staff user that created a payment.
791 * The web staff client now requires staff users to explicitly set a
792 billing type when adding a manual bill.
793 * The web staff client's patron bill annotation modal now works.
794 * Patron barcode search completion in the web staff client now allows
795 the user to select from all of the matching patron records.
796 * The Hold Shelf Slip print template in the web staff client now has
797 access to the call number.
798 * The Checkout Receipt print template in the web staff client now can
799 include summary financial information, incuding current balance, total
800 paid on outstanding fines, and total owed.
801 * The web staff print templates for current and historical bills can
802 now include copy barcode and title.
803 * Fixes a bug that resulted in some catalog searches unexpectedly
805 * Fixes a bug that resulted in catalog searches that specify a location
806 limit returning incorrect results.
807 * Fixes a bug where deleted copies could make records visible in the
809 * Fixes a bug where certain queries on copies used in the public catalog
811 * Fixes a bug place a hold request in the public catalog could result
812 in "forgetting" the type and library of the user's previous search.
813 * The web staff client now respects staff user session timeouts, and
814 will log out all open tabs if a user's session has timed out.
815 * The web staff Z39.50 page will now give the staff user an alert if
816 they attempt to import a record with a duplicate TCN.
817 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
818 entries from being deleted.
819 * Fixes a bug that made using the volume/copy editor to change a copy's
821 * The administration interface for hard due dates now ensures that
822 new (or edited) ceiling dates have their time component set to end
823 of day, resolving an issue where ceiling dates would not be applied
824 during the ceiling date itself.
825 * The web staff client can now include dynamic information in browser
826 tab titles, e.g., "Smith, Jane - Checkout".
827 * The Concerto sample data set now includes data allowing for testing
828 placing holds on monographic parts.
829 * Asset merging during bibliographic record merging now correctly
830 recognizes call number prefixes and suffixes and deletes disused
832 * Fixes a bug where displaying user surveys could result in PCRUD
834 * Fixes a bug where pg_restore of an Evergreen database could fail
835 to create certain indexes on the `actor.usr` table.
839 We would like to thank the following individuals who contributed code,
840 tests and documentation patches to the 3.0.2 point release of
871 This release contains several bug fixes improving on Evergreen 3.0.0
873 * Fixes a bug in the web staff client that prevented initials from being
874 stored with copy notes.
875 * Adds billing types that may have been missed by systems that were
876 running Evergreen prior to the 1.4 release.
877 * Fixes a web staff client bug with the CSV export option available from
878 the Import Queue in the MARC Batch Import/Export interface.
879 * Adds the missing copy alert field in the web client's volume/copy
881 * Fixes a bug where the setting to require date of birth in patron
882 registration was not being honored in the web staff client.
883 * Fixes a bug in the web staff client patron registration form where the
884 password wasn't generating from the last four digits of the patron's
886 * Fixes an issue in the web staff client where the complete barcode did
887 not display in some interfaces when partial barcodes were scanned.
888 * Fixes an HTML error in the new copy tags that display on the record
890 * Fixes a web staff client bug where recording a large number of in-house
891 uses at one time doesn't display a confirmation dialog once it hits the
893 * Adds a _Print Full Grid_ action in the web staff client
894 holds pull list to allow staff to print the entire pull list as it
895 displays on the screen. This change also changes the _Export CSV_ action
896 to an _Export Full CSV_ option.
897 * Fixes an issue with the Patron Messages interface that prevented it
898 from saving column configuration changes in the web staff client.
899 * Fixes a bug in the web staff client where a billing prompt did not
900 correctly display after marking an item damaged in those systems that
901 have enabled the setting to bill for damaged items.
902 * Adds an option to the specific due date feature that allows saving
903 that due date until logout. This allows all circulations from a given
904 workstation to be due on the same date.
908 We would like to thank the following individuals who contributed code,
909 tests and documentation patches to the 3.0.1 point release of
931 The minimum version of PostgreSQL required to run Evergreen 3.0 is
932 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
934 Change to Names of Shared Libraries
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
936 OpenSRF 3.0 changes how the shared libraries for services written in
937 C are named. If upgrading from an earlier version of Evergreen,
938 `opensrf.xml` should be edited so that shared library file names
939 listed in the `<implementation>` tag start with "lib". For example,
942 ---------------------------------------------------------------------
944 <language>C</language>
945 <implementation>oils_cstore.so</implementation>
946 ---------------------------------------------------------------------
948 should be changed to:
951 ---------------------------------------------------------------------
953 <language>C</language>
954 <implementation>liboils_cstore.so</implementation>
955 ---------------------------------------------------------------------
957 SIP Bugfix Requires SIPServer Upgrade
958 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
960 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
961 crash" requires that you also upgrade SIPServer with the fix for
962 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
963 SIP client problems." This means that if you use SIP2 with Evergreen,
964 you must also upgrade SIPServer to the latest commit in the Git
965 repository. Conversely, if you upgrade SIPServer to the latest commit
966 in Git, you must also upgrade Evergreen or, at least, apply the patch
967 for Launchpad Bug 1542495. These two patches are complementary and
968 cannot be applied independently of one another.
970 `open-ils.auth.login`
971 ~~~~~~~~~~~~~~~~~~~~~
972 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
973 API's in the `opensrf_core.xml` file.
978 ---------------------------------------------------------------------
979 --- a/Open-ILS/examples/opensrf_core.xml.example
980 +++ b/Open-ILS/examples/opensrf_core.xml.example
981 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
983 <match_string>open-ils.auth.authenticate.verify</match_string>
984 <match_string>open-ils.auth.authenticate.complete</match_string>
985 + <match_string>open-ils.auth.login</match_string>
986 <match_string>open-ils.auth_proxy.login</match_string>
987 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
988 <match_string>open-ils.actor.user.password</match_string>
989 ---------------------------------------------------------------------
993 Administrators of Evergreen who use RTL locales and who have customized
994 `style-rtl.css.tt2` should now incorporate their customizations into
997 Multi-Time Zone Installations
998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000 For Evergreen consortia that span more than one time zone, the following
1001 query will adjust all historical, unaged circulations so
1002 that if their due date field is pushed to the end of the day, it is done
1003 in the circulating library's time zone, and not the server time zone.
1005 It is safe to run this after any change to library time zones.
1007 Running this is not required, as no code before this change has
1008 depended on the time string of '23:59:59'. It is also not necessary
1009 if all of your libraries are in the same time zone, and that time zone
1010 is the same as the database's configured time zone.
1019 for ou_id in select id from actor.org_unit loop
1020 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
1021 if new_tz is not null then
1022 update action.circulation
1023 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
1024 where circ_lib = ou_id
1025 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
1034 Deprecation of XUL staff client
1035 -------------------------------
1036 Starting with the release of 3.0.0, patches that fix XUL bugs will not
1037 be merged into master or backported unless they meet one or more of
1038 the following conditions:
1040 a. the bug is a security issue
1041 b. the bug involves the destruction of data
1042 c. the bug is a regression of functionality in the XUL staff client
1043 introduced by other work done to Evergreen
1045 Under no circumstances will XUL staff client feature enhancements be merged.
1047 This policy will continue through the 3.0.x and 3.1.x maintenance
1048 release cycles, and will become moot upon the release of 3.2.0, when
1049 the XUL staff client is slated to be entirely removed.
1058 Evergreen 3.0 features a new, modern staff client that runs in the web browser
1059 and can be used on desktop and mobile devices. All functional areas of the
1060 system, including circulation, cataloging, acquisitions, serials, reports,
1061 booking, administration, and offline circulation, are available in the new staff
1062 client. Chrome and Firefox are officially supported for use with the web client.
1064 Library staff will no longer need to download separate software to perform most
1065 actions in Evergreen. A Chrome plugin called Hatch will be available as a
1066 separate installation for workstations that require seamless, dialog-free
1067 printing to multiple printers.
1069 In addition to adding more portability and stability, the new staff client also
1070 presents a cleaner and more modern interface for users. By virtue of running in
1071 a browser, actions that users are accustomed to performing on other web sites
1072 should now be available in the Evergreen client.
1074 The old, XUL client will continue to be available to allow for a gradual
1075 transition to the browser-based client, but no new features will be added. The
1076 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1086 New EDI Order Generator
1087 ^^^^^^^^^^^^^^^^^^^^^^^
1092 . New database tables exist for configuring vendor-specific EDI order
1096 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1098 * `acq.edi_attr_set`
1099 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1101 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1102 the stock configuration found in the JEDI template.
1103 * `acq.edi_attr_set_map`
1104 ** Link between `edi_attr`s and `edi_attr_set`s.
1106 . EDI Attribute Sets are manged via a new (browser client only) configuration
1107 interface at 'Administration -> Acquisitions Administration -> EDI
1110 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1111 is not set, default values will be used. Links between an EDI account
1112 and an attribute set are managed in the EDI Accounts configuration
1115 . Local modifications to the stock EG JEDI template are managed by modifying
1116 and/or adding additional `edi_att_set`s as needed.
1118 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1119 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1121 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1122 definition is no longer required and can be disabled.
1127 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1128 specifies whether PO's generated via the account should be built using
1129 EDI attributes or fall back to traditional JEDI A/T template generation.
1131 This allows sites to activate EDI attributes on a per-account basis, making
1132 it possible to migrate piecemeal to EDI attributes. For the initial roll
1133 out of this new feature, no accounts will be configured to use EDI
1134 attributes by default.
1140 3 Day Courtesy Notice by SMS
1141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1142 New optional SMS text notification to be sent out 3 days prior to the due
1143 date of any circulating item for patrons who have an SMS text number and
1144 carrier stored in their accounts. This action trigger is disabled by default,
1145 but can be enabled and modified by going into 'Administration -> Local Administration ->
1146 Notifications / Action Triggers'.
1148 You may wish to make use of granularity so that these messages are batched
1149 and sent at the same time each day.
1154 Add Description Field to Circulation and Hold Configuration Entries
1155 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1156 The circulation and hold policy configuration rules now each have a
1157 description field. This allows administrators to add comments to
1158 describe the purpose of each rule.
1163 Apache Internal Port Configuration Option
1164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1165 Apache configuration now supports a new variable which allows admins to
1166 specify the port used by Apache to handle HTTP traffic. The value is
1167 used for HTTP requests routed from Perl handlers back to the same Apache
1168 instance, like added content requests. Use this when running Apache
1169 with a non-standard port, typical with a proxy setup. Defaults to "80".
1172 -------------------------------------------------------------------
1175 PerlSetVar OILSWebInternalHTTPPort "7080"
1178 -------------------------------------------------------------------
1183 Configurable Bib Record Display Fields
1184 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1186 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1187 fields: 'Display Field?' and 'Display XPath'.
1189 When 'Display Field' is set to true, data from the field will be extracted
1190 from each record and added to a new table of display data for each bib
1193 If a value is present in the 'Display XPath' field, this XPath will be
1194 applied to the extracted data *after* the base XPath (from the 'XPath'
1195 field) is applied to each field.
1197 This data acts as a replacement for the various and sundry ways bib record
1198 data is currently extracted, including inline XPath in the TPAC, reporter
1199 views, real-time 'MVR' compilation from MODS, etc. and will be available
1200 to the user interface, notification templates, etc. for rendering bib
1203 The browser client gets a new service 'egBibDisplay' which is capable
1204 of translating the display field data from various formats into
1205 data more suitable for JavaScript usage.
1207 The database gets 3 new views for representing display data in various
1210 * `metabib.flat_display_entry`
1211 ** List of all display fields linked to their configuration.
1212 * `metabib.compressed_display_entry`
1213 ** Same as `metabib.flat_display_entry` except there's one row
1214 per display field type, with 'multi' rows compressed into
1215 JSON arrays. Non-multi fields are represented as JSON
1217 * `metabib.wide_display_entry`
1218 ** Tabular view of display field data, one column per well-known
1219 field. Values are represented JSON, consistent with
1220 `metabib.flat_display_entry`. The view does *not* contain locally
1221 configured display fields, as each field must be encoded in
1222 the view and IDL definition. This is essentially a replacement
1223 for `reporter.simple_record`.
1228 After making changes to display field configuration, it's possible to
1229 reingest only display field data in the database using the following:
1232 ---------------------------------------------------------------------
1233 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1234 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1235 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1236 ---------------------------------------------------------------------
1242 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1243 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1244 The existing permission was incorrectly created with a code of
1245 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1246 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1247 update changes the permission code to match what the event requires.
1253 Hold Targeter V2 Repairs and Improvements
1254 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1255 * Make the batch targeter more resilient to a single-hold failure.
1256 * Additional batch targeter info logging.
1257 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1258 * Removes the confusingly named `--target-all` option
1259 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1260 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1262 New --next-check-interval Option
1263 ++++++++++++++++++++++++++++++++
1264 Specify how long after the current run time the targeter will retarget
1265 the currently affected holds. Applying a specific interval is useful
1266 when the retarget-interval is shorter than the time between targeter
1269 For example, if the targeter is run nightly at midnight with a
1270 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1271 since the holds won't be processed again until 48 hours later. This
1272 ensures that the org unit closed date checks are looking at the correct
1275 This setting overrides the default behavior of calculating the next
1276 retarget time from the retarget-interval.
1278 New --soft-retarget-interval Option
1279 +++++++++++++++++++++++++++++++++++
1280 This is a replacement for (and rebranding of) the `--skip-viable` option.
1281 The new option allows for time-based soft-targeting instead simple binary
1282 on/off soft-targeting.
1284 How soft-targeting works:
1286 * Update hold copy maps for all affected holds
1287 * Holds with viable targets (on the pull list) are otherwise left alone.
1288 * Holds without viable targets are retargeted in the usual manner.
1294 New marc_export --descendants Option
1295 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1297 The `marc_export` script has a new option, `--descendants`. This option
1298 takes one argument of an organizational unit shortname. It works much
1299 like the existing `--library` option except that it is aware of the
1300 org. tree and will export records with holdings at the specified
1301 organizational unit and all of its descendants. This is handy if you
1302 want to export the records for all of the branches of a system. You
1303 can do that by specifying this option and the system's shortname,
1304 instead of specifying multiple `--library` options for each branch.
1306 The `--descendants` option can be repeated, as the `--library` option can.
1307 All of the specified org. units and their descendants will be included
1308 in the output. It can also be combined with individual `--library`
1309 options when necessary.
1314 RTL and LTR Public Catalog Stylesheets Merged
1315 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1316 The RTL stylesheet for the public catalog,
1317 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1318 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1319 template will provide RTL or LTR styles based on the value of
1320 the `rtl` flag of the active locale. An `rtl` variable is also available
1321 in the template to allow the correct style to be chosen.
1326 Miscellaneous Improvements
1327 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1329 * If a filter is in effect in the Library Settings Editor,
1330 the filter will continue to be applied after a user
1331 changes the selected library.
1332 * Copy templates used for serials now correctly link to age
1333 protection rules and MARC item type values (for the
1334 "Circ as Type" field). During upgrade, the database update
1335 will set to NULL any age protection and circ as type fields
1336 in serial copy templates that do not point to defined values.
1341 Obsolete Internal Flag Removed
1342 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1344 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1345 flag was removed from the `config.internal_flags` table. It was
1346 rendered obsolete by the addition of the 3 flags to control the
1347 browse, search, and facet indexing.
1352 Tweaks to Caching/Expiry of Public Catalog Assets
1353 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1354 The default cache expiration time for static assets (e.g.,
1355 CSS, image, and JavaScript files) in the public catalog and
1356 the Kid's PAC has been increased to one year. Links to all
1357 such assets now have a cache-busting value tacked on as a
1358 query parameter. This value is refreshed when `autogen.sh` is
1359 run, but it can also be manually set by adjusting the
1360 `ctx.cache_key` Template Toolkit variable.
1365 Action/Trigger Events Data Purging
1366 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1368 Action/Trigger event definitions have a new field called 'Retention
1369 Interval'. When an optional interval value is applied, events and
1370 template output data linked to the event definition will be deleted
1371 from the database once they reach the specified age.
1373 Retention Interval Restrictions for Passive Hooks
1374 +++++++++++++++++++++++++++++++++++++++++++++++++
1376 Restrictions are placed on retention interval values for event definitions
1377 using passive hooks to prevent data from being deleted while it's still
1378 needed by the system.
1380 The presence of event data is how the system knows not to send duplicate
1381 events. As long as a scenario exists where a duplicate event may be
1382 generated, the events must be retained.
1384 To apply a retention interval value to a passive-hook event definition:
1386 * The event definition must have a max_delay value.
1387 * The retention interval must be larger than the difference between
1388 the `delay` and `max_delay` values.
1390 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1391 interval must be greater than 3 days to ensure no duplicate events are
1392 created between the first event on day 7 and the end of the event validity
1398 A new `purge_at_events.sh` script is installed in the bin directory
1399 (typically `/openils/bin`) which should be added to CRON for regular
1402 NOTE: On large data sets, this script can take a long time to run and
1403 create higher than normal I/O load as it churns though the event and
1404 event_output tables. You may wish to run the script by hand the first
1405 time so it can be monitored. It can be run in psql like so:
1408 ---------------------------------------------------------------
1409 SELECT action_trigger.purge_events();
1410 ---------------------------------------------------------------
1412 NOTE: On *very* large data sets (10s to 100s of millions of event and
1413 event_output rows), it may be advisable to first repopulate the `event`
1414 and `event_output` tables with only the desired data before starting
1415 regular purges. This can be done, for example, using the copy to temp
1416 table, truncate source table, repopulate source table from temp table
1417 approach. This will be much faster than the `purge_events()` function
1418 in cases where most of the data will be purged.
1423 A number of `action_trigger.hook` entries which have always been treated
1424 as active hooks, though are configured as passive hooks, have been
1425 updated to properly reflect the non-passive-ness. This allows for
1426 simpler configuration of their retention interval values.
1432 Remove JSPAC Redirects
1433 ^^^^^^^^^^^^^^^^^^^^^^
1434 Future versions of Evergreen will no longer contain automatic redirects
1435 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1436 that the JSPAC is no longer supported. Existing sites, however, may
1437 wish to retain JSPAC redirects in their Apache configuration files since
1438 JSPAC URLs may still be used in the wild to access their catalogs.
1440 The original JSPAC URL redirects are all retained in the file
1441 `Open-ILS/examples/jspac_redirects.conf` for reference.
1451 New open-ils.auth.login API
1452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1453 The `open-ils.auth` service has a new API for requesting an authentication
1454 token. It performs the same steps as the
1455 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1456 using the bare password. No intermediate password hashing is required.
1458 The paramaters are the same as the `.complete` call with a few modifications.
1460 1. Using the generic 'identifier' parameter in combination with the
1461 'org' parameter allows the API to reliably determine if an identifier
1462 value is a username or barcode. The caller is no longer required to
1463 make that determination up front.
1465 2. The 'nonce' parameter is no longer used.
1471 Batch Patron Contact Invalidation
1472 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1473 The following methods are used to mark patron contact fields
1474 as invalid by moving the invalid value to a standing penalty:
1476 * `open-ils.actor.invalidate.email`
1477 * `open-ils.actor.invalidate.day_phone`
1478 * `open-ils.actor.invalidate.evening_phone`
1479 * `open-ils.actor.invalidate.other_phone`
1481 These methods now accept a fifth argument specifying the value
1482 of the contact field, e.g., a specific phone number or email
1483 address. If supplied, and if a specific patron ID (the first
1484 argument) is not supplied, all patrons with that specific contact
1485 value will have it marked invalid.
1495 Pure-SQL catalog searching
1496 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1497 Public and staff catalog search is now both more accurate and faster
1498 by redesigning how the visibility of records is calculated.
1508 Authority Record and Headings Browse Improvements
1509 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1510 Various improvements are made to support for authority records
1511 and headings browsing:
1513 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1514 headings from authority records. Since the MODS and MADS stylesheets
1515 extract headings in similar ways, duplicate browse entries are now
1516 much less likely to occur.
1517 * A new configuration table, `authority.heading_field`, is now used
1518 to specify how headings should be extracted from authority records.
1519 * Related headings can now be identified as narrower or broader when
1520 browsing in the public catalog.
1521 * See references are now more reliably included in the browse list.
1522 * Scope (public) notes now display only under the main heading.
1523 * There is now a global flag, Display related headings (see-also) in browse,
1524 that can be used to control whether related headings (see-alsos) are
1525 displayed in the public catalog list.
1526 * A complete set of thesauruses are now included in the seed data. Thesauruses
1527 can now be identified using short and long codes.
1528 * The labels for see and see-also references in the public catalog are
1529 a bit more patron-friendly, and can now be tweaked via TPAC template
1530 customization in the browse.tt2 file.
1536 Copy Tags and Digital Bookplates
1537 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1538 Copy tags will allow staff to apply custom, pre-defined labels or tags
1539 to copies. Copy tags are searchable in both the staff client and public
1540 catalog. This feature was designed to be used for Digital Bookplates to
1541 attach donation or memorial information to copies, but may be used for
1542 broader purposes to tag items.
1544 Each copy tag can either be publicly-visible or visible only to staff.
1545 Copy tags also have types that can be used for restricting catalog
1546 searches on copy tags to particular types.
1548 Copy tags are displayed in the copy table in the record summary page in
1549 the public catalog, and a new library setting can be used to add
1550 a "Digital Bookplate" search field. Copy tags can also be used
1551 as a search filter, e.g.,
1553 * `copy_tag(bookplate, jane smith)`: search for records that have a
1554 copy tag of type 'bookplate' whose value contains 'jane smith'.
1555 * `copy_tag(*, jane smith)`: search for records that have a
1556 copy tag of any type whose value contains 'jane smith'.
1558 All staff-side interfaces related to copy tags exist only in the web
1559 staff client. There are two new administration interfaces for managing
1560 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1561 button for applying copy tags to copies; that interface can also be
1562 used to create new copy tags on the fly. Furthermore, the copy buckets
1563 interface now has an 'Apply Tags' action for assigning tags to groups
1569 Two new permission are included:
1571 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1572 'Administration -> Server Administration -> Copy Tag Types'
1573 * `ADMIN_COPY_TAG`: required to create a new tag under
1574 'Administration -> Local Administration -> Copy Tags'
1576 The existing permission `UPDATE_COPY` controls whether or not a user
1577 can link copies to tags.
1581 A new library setting, 'Enable Digital Bookplate Search', controls
1582 whether to display a 'Digital Bookplate' field in the search index
1583 drop-downs in the catalog. A 'Digital Bookplate' search will include
1584 all records that have a copy that matches the tag specified by the user.
1585 It should be noted that this library setting does not affect the
1586 display of copy tags on the catalog record summary page.
1591 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1592 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1593 The call number prefix and suffix, when present, are now included in
1594 subfields $k and $m of the 852 field when running `marc_export` with
1595 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1596 server configured to embed item data in 852 fields, the affixes are now
1597 included in subfields $k and $m.
1607 Batch Editing of Patron Records
1608 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1609 There is a now a new interface analogous to the Copy Bucket interface
1610 to select and group a set of users into a User Bucket.
1611 The addition of users to a User Bucket is possible from the Patron Search
1612 interface by the use of a new grid Action, and directly on the User Bucket
1613 interface by user barcode. It is also possible to add users to a User
1614 Bucket by uploading a text file that contains a list of user barcodes.
1616 From this interface it is possible to perform a set of specific batch update
1617 operations on user records.
1622 These fields can now be changed in batch via an action on the User Bucket
1623 grid if the staff user has the `UPDATE_USER` permission:
1626 * Primary Permission Group (group application permissions consulted)
1628 * Home Library (`UPDATE_USER` checked against both old and new value)
1629 * Privilege Expiration Date
1630 * Barred flag (`BAR_PATRON` permission consulted)
1631 * Internet Access Level
1633 Changes made in this interface can be rolled back.
1635 As a batch process, rather than a direct edit, this mechanism explicitly skips
1636 processing of Action/Trigger event definitions for user update.
1641 The batch edit mechanism also allows for the batch deletion of user. The staff
1642 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1644 Changes made in this interface can be rolled back.
1646 As a batch process, rather than a direct edit, this mechanism explicitly skips
1647 processing of Action/Trigger event definitions for user deletion.
1649 This mechanism does not use the Purge User functionality, but instead simply
1650 marks the users as deleted.
1652 Editing Statistical Category Entries
1653 ++++++++++++++++++++++++++++++++++++
1655 All users in the bucket can have their Statistical Category Entries
1656 modified. Unlike user data field updates, modification of Statistical
1657 Category Entries is permanent and cannot be rolled back.
1659 As a batch process, rather than a direct edit, this mechanism explicitly skips
1660 processing of Action/Trigger event definitions for user update.
1662 New Service Requirement
1663 +++++++++++++++++++++++
1665 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1666 unused in production. If this service has been removed from the configuration
1667 of a live Evergreen instances, it will need to be added back in order for
1668 batch user editing to succeed.
1673 Honor Timezone of the Acting Library
1674 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1679 * Display day-granular due dates in the circulating library's timezone.
1680 * Only display the date portion of the due date for day-granular circulations.
1681 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1682 * Provide infrastructure for more advanced formatting of timestamps.
1683 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1688 This is a followup to the work done for 2.12, where we added the ability
1689 for the client to specify a timezone in which timestamps should be interpreted
1690 in business logic and the database.
1692 Most specifically, this work focuses on circulation due dates and the closed
1693 date editor. Due dates, where displayed using stock templates (including
1694 receipt templates) and used for fine calculation, are now manipulated in the
1695 library's configured timezone. This is controlled by the new 'lib.timezone'
1696 setting available via the Library Settings Editor, loaded from the server when
1697 required. Additionally, closings are recorded in the library's timezone so that
1698 due date calculation is more accurate. The closed date editor is also
1699 taught how to display closings in the
1700 closed library's timezone. Closed date entries also explicitly record if they
1701 are a full day closing, or a multi-day closing. This significantly simplifies
1702 the editor, and may be useful in other contexts.
1704 To accomplish this, we use the moment.js library and the moment-timezone addon.
1705 This is necessary because the stock AngularJS date filter does not understand
1706 locale-aware timezone values, which are required to support DST. A simple
1707 mapper translates the differences in format values from AngularJS date to
1710 Of special note are a set of new filters used for formatting timestamps under
1711 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1712 filters provide the functionality, and autogrid is enhanced to make use of
1713 these where applicable. egGrid and egGridField are also taught to accept
1714 default and field-specific options for applying date filters. These filters may
1715 be useful in other or related contexts.
1717 The egDueDate filter, used for all existing displays of due date via Angular
1718 code, intentionally interprets timestamps in two different ways WRT timezone,
1719 based on the circulation duration. If the duration is day-granular (that is,
1720 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1721 of seconds) then the date is interpreted as being in the circulation library's
1722 timezone. If it is an hourly loan (any duration that does not meet the
1723 day-granular criterium) then it is instead displayed in the client's timezone,
1724 just as all other timestamps currently are, because of the previous Evergreen
1727 The public catalog is adjusted to always display the due date in the circulating
1728 library's timezone. Because the public catalog displays only the date portion of the due
1729 date field, this difference is currently considered acceptable. If this proves
1730 to be a problem in the future, a minor adjustment can be made to match the
1731 egDueDate filter logic.
1733 Now that due dates are globally stored in the configured timezone of the
1734 circulating library, the automatic adjustment to day-granular due dates needs
1735 to take those timezones into account.
1737 An optional SQL command is provided by the upgrade script to retroactively
1738 adjust existing due dates after library configuration is complete.
1744 Enhancements to Hard Due Date Functionality
1745 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1746 It will now be possible to delete Hard Due Date Values for dates that have
1747 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1748 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1749 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1754 Patron Search by Birth Date
1755 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1756 * Now you can include the patron birth year and/or birth month and/or
1757 birth day when searching for patrons using the web staff client.
1758 * Day and month values are exact matches. E.g. month "1" (or "01")
1759 matches January, "12" matches December.
1760 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1761 1915, 1599, etc. For exact matches use the full 4-digit year.
1765 Patron Search from Place Hold
1766 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1767 This feature allows staff members, when placing a
1768 hold on behalf of a patron in the web staff client, to search for
1769 patrons by names and other searchable patron information, rather than
1770 relying on barcode alone. In particular, after performing a catalog
1771 search or going to a specific bib record and clicking the 'Place Hold'
1772 button, the form now includes a 'Patron Search' button. This button
1773 will open a dialog allowing the staff member search for and select
1779 Retrieve Recent Patrons
1780 ^^^^^^^^^^^^^^^^^^^^^^^
1782 Adds a new library setting 'Number of Retrievable Recent Patrons'
1783 ('ui.staff.max_recent_patrons') that specifies the number of recently
1784 retrieved patrons that can be re-fetched from the staff client.
1786 A value of 0 means no recent patrons can be retrieved.
1787 A value greater than 1 means staff will be able to retrieve multiple
1788 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1790 The default value is 1 for backwards compatibility.
1797 Fuller title in XUL client Simplified Pull List
1798 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1799 The Simplified Pull List in the XUL client will now display subfields 245$n and
1800 $p in the title field. The addition will make it easier for staff to distinguish
1801 between different parts or seasons in a series.
1807 Transit Cancel Time and Terminology Change
1808 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1813 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1814 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1815 are preserved in the database, though still not visible to the end user in the staff client.
1816 This allows for better tracking of when transits are canceled for the purposes of knowing
1817 which staff member canceled the transit, etc.
1819 NOTE: This change may require the re-creation of transit reports to filter out canceled
1820 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1821 Is NULL' will suffice.
1823 "Canceled Transit" Terminology Change
1824 +++++++++++++++++++++++++++++++++++++
1826 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1827 For internal continuity, however, the following permission codes have not changed:
1830 * `ABORT_REMOTE_TRANSIT`
1831 * `ABORT_TRANSIT_ON_LOST`
1832 * `ABORT_TRANSIT_ON_MISSING`
1840 Offline Circulation Available in Web Staff Client
1841 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1842 Offline circulation is now available in the web staff client. In order to use the
1843 offline interface, users must first log into the web staff client, perform
1844 a patron search, select a user from the results, and open the patron editor
1845 interface to collect all the relevent configuration information for the
1846 workstation. In addition, the offline interface available from the Circulation
1847 menu provides a 'Download block list' button for users who are logged in.
1849 As is the case in the old staff client, users can check materials in and out,
1850 renew items, and create new patron accounts while offline. The patron fields
1851 available in the offline patron registration editor are the same ones that
1852 are available to staff when working online.
1856 Add Circ Modifier to Record Detail Page in Staff TPAC
1857 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1858 The circulation modifier field is added to the table of copies to make
1859 more information available to staff without having to open
1866 Date+Time Format Settings for Web Client
1867 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1869 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1870 and adds two settings for use with the webstaff client:
1872 * 'Format Dates with this pattern'
1873 * 'Format Date+Time with this pattern'
1875 These settings use format strings as documented here:
1877 https://docs.angularjs.org/api/ng/filter/date
1879 There is overlap with how the Dojo formats worked, but also some differences.
1881 The original 'Format Dates' and 'Format Times' settings worked together, but the
1882 new settings work independently. Certain field elements will use one, and
1883 certain field elements will use the other. These distinctions are hard-coded
1884 in the various UI templates, with the idea being that timestamp fields in
1885 which the date component alone is sufficient information (for example, date of birth)
1886 will use the 'Format Dates' setting. Fields where the time component is
1887 important (for example, checkout time) will use the 'Format Date+Time' setting.
1889 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1890 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1896 Global Option to Remove Sound for a Specific Event
1897 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1898 A new `nosound.wav` file has been added to the web client. The file can be used
1899 to globally disable audio alerts for a specific event on an Evergreen system.
1901 For example, to silence the alert that sounds after a successful patron search:
1905 mkdir -p /openils/var/web/audio/notifications/success/patron/
1906 cd /openils/var/web/audio/notifications/success/patron/
1907 ln -s ../../nosound.wav by_search.wav
1914 The official Evergreen manual has been split into eight new manuals, each
1915 designed for a specific audience. This new approach is designed to make
1916 the documentation more readable and usable.
1918 The specific audiences for the new manuals are:
1920 * Acquisitions staff
1923 * Public services staff who use the public catalog
1925 * System administrators who use the command line
1926 * System administrators who use the Web client
1927 * System administrators and programmers who wish to integrate Evergreen
1928 with other technologies
1930 All manuals are available at http://docs.evergreen-ils.org
1936 Improvements to ebook API
1937 ^^^^^^^^^^^^^^^^^^^^^^^^^
1939 Evergreen now supports checking out and placing holds on
1940 OverDrive and OneClickdigital ebook titles from within the public
1941 catalog. This is an experimental feature. It is not recommended for production
1942 use without careful testing.
1944 When ebook integration is enabled, a "Check Out E-Item" link will be
1945 displayed when viewing an ebook title from a supported vendor in the
1946 catalog. Clicking on the link allows the user to check out and download
1947 that title from the vendor directly within the catalog.
1949 If no copies are available for the title, a "Place Hold on E-Item" link
1950 is displayed instead, and the user may place a hold on the title. (Note
1951 that some vendors require the user's account to have an email address
1952 before permitting a hold.)
1954 My Account includes the ability to view current ebook checkouts and
1955 holds, download already-checked-out titles, and cancel holds.
1957 For API integration to work, you need to request API access from the
1958 vendor, and the vendor must have a way of authenticating your patrons.
1959 Your Evergreen system also needs to be configured for ebook API
1960 integration, following the instructions in the command line system
1961 administration manual
1964 This feature assumes that you are importing MARC records supplied by the
1965 vendor into your Evergreen system, using Vandelay or some other MARC
1966 import method. This feature does not search the vendor's online
1967 collections or automatically import vendor records into your system; it
1968 merely augments records that are already in Evergreen.
1970 Improvements to Bill Payment Pages
1971 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1972 The bill payment pages in the public catalog have been revamped
1975 * use the term "charges" instead of "fees"
1976 * include images of credit cards accepted
1977 * make the default print receipt template match other itemized receipts;
1978 note that this change is not automatically applied when upgrading.
1979 * display billing type
1980 * add button to pay only selected charges
1981 * reformat the credit card number input page
1987 Clickable Copy Locations
1988 ^^^^^^^^^^^^^^^^^^^^^^^^
1989 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1990 the associated copy location will display as a link in the public catalog summary display.
1991 This link can be useful for retrieving maps or other directions to the copy
1992 location to aid users in finding material.
1997 Download Checkout History CSV Fixed for Large Number of Circulations
1998 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1999 Downloading checkout history as a CSV from My Account has been fixed
2000 for users with a large circulation history. Previously, this would
2001 time out for patrons with more than 100 or so circulations.
2003 This feature no longer uses the action/trigger mechanism and the public catalog
2004 now generates the CSV directly. The old action/trigger code is still
2005 present in the database and should be removed at some point in the
2011 Google Books Preview Rewrite
2012 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2013 The Google Books Preview functionality in record detail pages has been
2014 rewritten to modernize its style and optimize its performance:
2016 * The Dojo JavaScript framework is no longer used, saving approximately
2017 150K of JavaScript and CSS and four network requests per page load.
2018 * The Embedded Viewer is not loaded unless a possible preview is found,
2019 saving more network and memory overhead.
2020 * The Google Books Loader is used to load the Embedded Viewer instead of the
2021 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
2023 * All variables are self-contained and do not pollute the global namespace.
2024 * Event listeners are registered to handle clicks, rather than attaching
2025 `href="javascript:function()"` to <a> elements.
2026 * Book previews are displayed in a panel sized according to the viewport
2027 of the browser, improving its appearance on both mobile and desktop
2029 * The rewritten code is now served up directly from
2030 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
2035 jQuery for the Public Catalog
2036 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2037 This release adds optional support for jQuery in the public catalog. This support
2038 is enabled by setting the `ctx.want_jquery` variable to a true value in the
2039 `config.tt2` template.
2045 New Popularity Parameters
2046 ^^^^^^^^^^^^^^^^^^^^^^^^^
2047 New popularity parameters for in-house use over time and for count of distinct
2048 organizational units that own a title are now available. Evergreen sites
2049 can use these parameters to create new statistical popularity badges for
2050 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
2052 The in-house use parameters will apply a badge to titles that have the most
2053 in-house use activity over time. The organizational unit count parameter
2054 will apply a badge to titles owned by the most number of libraries in a
2055 consortium. Ownership is determined by the copy's circulation library.
2060 Option to Suspend Holds at the Time They are Placed
2061 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2062 Users now have the option to suspend a hold at the same time they place the
2063 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
2064 who want to suspend a hold at the time it is placed. There is also an option
2065 to set the activation date at the same time. This option is also available
2066 when placing holds on a batch of titles from 'My List' and will apply to
2067 all the titles in the batch.
2078 Fix to reporter.classic_current_circ View
2079 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2080 The `reporter.classic_current_circ` view, which is part of some
2081 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
2082 has been fixed to not exclude loans for patrons who do not have a
2083 billing address set. Users of this view should rerun
2084 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2089 New Report Source Table Allowing Report of "Last" Deleted copy
2090 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2092 This source table allows you to construct a clever aggregate report template
2093 which will report bibliographic IDs where a library or a group of libraries
2094 no longer have a copy attached but *had* a copy attached. This is especially
2095 useful when a holdings sync is required with an external vendor.
2098 Instructions for creating a report template with this source:
2100 * Create a new report template using "Library Holdings Count with Deleted" as the source
2101 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2102 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2103 * Add Circulation Library -> "Organizational Unit ID" to Base Filters, with the Raw Data transform. In the list of Base Filters, change the operator to "In list"
2104 * Add "Bib ID" to Displayed Fields
2105 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2106 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2107 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2110 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2111 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2112 specified date range. Unfortunately the user will have to manually type the date range without the date
2113 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2114 copy and more than two deleted copies."
2119 Add Provider to Provider Note Link
2120 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2121 The Provider reporting source now includes a link to the Provider Note reporting source.
2126 Link ILS User and Working Location Reporting Sources
2127 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2128 The Working Location reporting source now has labels
2129 and it is now linked to the ILS User reporting source, allowing
2130 reports to display or filter on staff working location.
2135 New Circulation Report Source "All Circulation Combined Types"
2136 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2138 This report source will allow you to create a single report template for all of the following:
2141 * In-house uses of non-cataloged items
2143 * Circulations of non-cataloged items
2145 To distinguish between these different types of library use, it's important to display these columns
2146 in your report templates:
2155 Reports Template Searching
2156 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2157 A new form appears along the top of the reports interface for searching
2158 report templates. Once found, typical template actions (e.g. create new
2159 report) are available from within the results interface.
2161 Searches may be performed across selected (visible) folders or all
2162 folders visible to the logged in user.
2164 Searches are case-insensitive, any word order, with left-anchored words.
2165 All searched words must appear in at least one of the searched fields.
2170 * Searching for 'stat cat' matches:
2172 ** statistical category
2173 ** categories, statistical
2174 ** patrons (stat cat)
2175 * Searching for 'stat cat' does not match:
2177 *** both words must be present in the searched field(s)
2179 *** location contains 'cat' but it's not left-anchored.
2184 The templates, reports, and output interfaces now support paging via
2185 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2197 Web Staff Client Serials Module
2198 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2199 The serials module has been ported over to the web staff
2200 client, implementing a unified serials interface that combines
2201 ideas from both the serial control view and alternate serials
2202 control view from the old staff client.
2204 In addition to carrying over functionality that was available
2205 in the old staff client, several new features are included:
2207 * the ability to save prediction pattern codes as templates
2208 that can be shared and reused within an Evergreen database
2209 * a more streamlined interface for managing subscriptions,
2210 distributions, and streams
2211 * it is no longer necessary to create a starting issue in
2212 order to predict a run of issues; the dialog box for
2213 generating a set of predicted issues now lets you specify
2214 the starting point directly.
2215 * the ability to more directly edit MFHDs
2217 The new serials interfaces can be accessed from the record
2218 details page via a Serials drop-down button that links to
2219 a subscription management page, a quick-receive action, and
2220 a MFHD management page. There is also a new 'Serials Administration'
2221 page where prediction pattern and serial copy templates can
2232 SIP Bugfix Changes How Encoding Is Determined in Configuration
2233 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2235 The combined fix for the above mentioned SIP bugs alters the way that
2236 SIPServer looks up the output encoding in the configuration file (typically
2237 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2240 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2241 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2242 3. The +encoding+ element that is a child of the +implementation_config+ element that is itself a child of the +institution+ element of the currently active SIP account.
2243 4. If none of the above exist, then the default encoding (ASCII) is used.
2245 Number 3 is provided to ease the transition to the new code. It is
2246 the current location of the +encoding+ element in the sample
2247 configuration file and as such, where it is likely to be found in
2248 actual files. It is recommended that you alter your configuration to
2249 move this element out of the +implementation_config+ element and into
2250 its parent +institution+ element. Ideally, SIPServer should *not* look into
2251 the implementation config, and this check may be removed at some time
2259 Web Client Acknowledgments
2260 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2262 The project to develop a new browser-based web client launched four
2263 years ago at the September 2013 Evergreen developer hack-a-way when the
2264 developer community voted to move away from the XUL client and explore other
2265 platforms. The first web client preview became available in Evergreen 2.7 when
2266 circulation was available in the new platform.
2268 The browser-based client is available due to the work of many coders, testers,
2269 bug reporters, documentors, translators, project managers, spec writers, funders
2270 and other contributors over the past four years.
2272 The Evergreen project would like to acknowledge the following organizations
2273 that funded development of the Web Staff Client:
2276 * British Columbia Libraries Cooperative
2277 * Consortium of Ohio Libraries
2279 * Georgia Public Library Service
2280 * Grand Rapids Public Library
2282 * Kenton County Public Library
2283 * King County Library System
2286 * Pennsylvania Integrated Library System
2287 * Pioneer Library System
2290 The Evergreen project would also like to thank the following individuals who
2291 contributed code, translations, documentation patches, tests, bug reports,
2292 technical specifications, and project management to the Web Staff Client:
2329 * Freddy Enrique Pelayo Huapalla
2355 Evergreen 3.0 Acknowledgments
2356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2358 The Evergreen project would like to acknowledge the following
2359 organizations that commissioned developments in this release of
2363 * British Columbia Libraries Cooperative (BC Sitka)
2365 * Georgia Public Library Service
2366 * King County Library System
2368 * Pennsylvania Integrated Library System
2369 * Pioneer Library System
2371 We would also like to thank the following individuals who contributed
2372 code, translations, documentation patches, and tests to this release of
2421 We also thank the following organizations whose employees contributed
2424 * British Columba Libraries Cooperative
2428 * Emerald Data Networks, Inc.
2429 * Equinox Open Library Initiative
2431 * Grand Rapids Public Library
2432 * Indiana State Library
2434 * King County Library System
2435 * Lake Agassiz Regional Library
2436 * Laurentian University
2437 * Linn-Benton Community College
2439 * Merrimack Valley Library Consortium
2441 * North of Boston Library Exchange
2442 * Pennsylvania Integrated Library System
2443 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2445 * Traverse Area District Library
2447 We regret any omissions. If a contributor has been inadvertently
2448 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob