1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.11.
9 All bug fixes refer to the web staff client unless otherwise specified.
14 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
15 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
16 * Fixes various misspellings and capitalization issues in the interface.
17 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
18 * Fixes an issue with checking in hourly loans.
19 * Staff can now approve pending patron addresses in the patron edit interface.
20 * Prevents patron records from being merged with themselves.
21 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
22 * Fixes issues with duplicate transit records.
23 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
24 * Improvements to the Item Attribute Editor.
25 * Staff can now set a default search box in the Z39.50 search interface.
26 * Staff can now delete copy notes.
27 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
28 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
29 * Protects backordered acquisitions items from having their catalog items deleted.
30 * Fixes problems that occur when cloning a report template created in the XUL client.
31 * Fixes bugs that caused activity metric data when performing searches.
32 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern.
33 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
37 We would like to thank the following individuals who contributed code,
38 tests and documentation patches to the 3.0.12 point release of
67 This release contains bug fixes improving on Evergreen 3.0.10.
68 All bug fixes refer to the web staff client unless otherwise specified.
73 * Several strings are now displayed in the correct translation.
74 * Right clicking in grids results in more intuitive behavior.
75 * Usernames and barcodes containging the _%_ character no longer
76 experience problems logging in.
77 * Fixes cases in which the web client stops loading after the toolbar.
78 * Fixes problems in which using the web client in multiple tabs leads
79 to data inconsistency.
80 * Fixes an issue that caused authentication session checks to spam
81 the system and needlessly fill up logs.
82 * Boolean fields within grid views now say "Yes"/"No" instead of
84 * Fixes sorting issues in the patron search.
85 * Staff can now choose to print out only a selection of items out,
86 instead of having to print them all.
87 * The patron triggered event screen now respects the
88 `circ.staff.max_visible_event_age` library setting.
89 * Fixes an issue which caused an exception to be thrown during
90 non-cataloged item checkout.
91 * Fixes permission issues related to merging users.
92 * The bibliographic record summary now displays the call number that
93 matches the library's classification system.
94 * The copy editor now makes shelving locations visible to catalogers
95 from other libraries as needed.
96 * Once a record is overlayed in the Z39.50 screen, it is no longer
98 * Several fixes to the filters on the Holdings View screen.
99 * Several fixes to how empty volumes are created and displayed.
100 * Fixes to item and call number transfers.
101 * Fixes several issues with the item status list view.
102 * When adding new copies, the circulation library now defaults to the
103 call number's owning library.
104 * Fixes display issues with the Print Item Labels page.
105 * Fixes an issue in which the staff client and the OPAC displayed
106 different counts of available items.
110 We would like to thank the following individuals who contributed code,
111 tests and documentation patches to the 3.0.11 point release of
131 This release contains bug fixes improving on Evergreen 3.0.9. Note that
132 all bug fixes refer to the web staff client unless otherwise specified.
137 * Fixes right-click issues with the Web client grids
138 * Fixes an issue with the Default SMS Carrier in the patron edit form.
139 * Fixes an issue that allowed overdue notices to be sent to a patron
140 whose long overdue item has been paid for.
141 * Checking in precat items now displays the "Route to Cataloging" alert each
142 time the item is checked in.
143 * Fixes an issue in which the Adjust to Zero feature
144 does not close a checked-in lost circ.
145 * Deleted copies that are still checked out can now be checked in.
146 * Fixes a mislabeled column in the patron checkout grid.
147 * Fixes an error with the missing pieces functionality.
148 * Courier codes now display in the transit slip receipt preview.
149 * The Item Status grid now displays OU shortnames instead of full names
150 for the "Circulation Library" column.
151 * The Volume/Copy editor now allows users to remove a value from the Age
152 Hold Protection field.
153 * Barcode completion now works in copy buckets.
154 * The Z39.50 interface now notices when another record has been marked
156 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
157 the Z39.50 interface.
158 * Fixes a performance issue for the Validate button in the MARC Editor.
159 * Fixes an incorrect close tag in the Print Item Labels toolbar.
160 * Better scoping of copy tags in search results.
161 * Electronic Resource links now open in a new tab.
162 * Fixes an issue with the fiscal year close-out operation.
163 * Improves serials item deletes.
167 We would like to thank the following individuals who contributed code,
168 tests and documentation patches to the 3.0.10 point release of
193 This release contains bug fixes improving on Evergreen 3.0.8. Note that
194 all bug fixes refer to the web staff client unless otherwise specified.
199 * Fixes specific cases in which deleted records appear in search results.
200 * Fixes a performance issue with deleting patrons.
201 * The hold shelf dialog popup now lists the patron's notification
203 * Fixes an issue that prevented editing items when a monograph part
205 * Patron information is now available for use in the bills_current
206 and bills_historical receipt templates.
207 * The browser's "This page may contain unsaved data" warning now
208 appears when users click the update
209 expire date button in a patron account and attempt to navigate away
211 * The holds tab of the patron record now includes a monograph part
213 * The barcode box in the checkout screen
214 no longer hovers above patron record tabs when
215 staff users scroll down.
216 * Fixes an issue with the date of birth in the patron edit scren.
217 * Fixes an issue with the dropdown of billing type options.
218 * The Item Status screen now includes as a floating group column.
222 We would like to thank the following individuals who contributed code,
223 tests and documentation patches to the 3.0.9 point release of
226 * BC Libraries Cooperative
232 * Blake Graham-Henderson
249 This release contains bug fixes improving on Evergreen 3.0.7. Note that
250 all bug fixes refer to the web staff client unless otherwise specified.
258 * The MARC editor now handles 008 fields better.
259 * Adds spaces between subfields when suggesting a call
260 number for a new volume.
261 * MarcXML exports from the MARC Batch Import/Export ->
262 Export Records screen now downloads the file, rather than opening
264 * The Item Status Circulation Library column now displays a
265 shortname rather than the full library name.
266 * The Item Status Remaining Renewals column now displays
268 * The Item Status now has a "Last Renewal Workstation" column
270 * Fixes the circulation counts displayed in Item Status Details.
271 * Fixes an issue where multiple copies with different values for required
272 statistical categories could not be edited and saved in batch.
273 * Add an option to remove floating in the copy editor.
274 * Fixes an issue with the floating dropdown in the copy editor.
275 * Fixes a problem in which the copy template didn't properly copy
277 * Reduces the number of API calls that the MARC Editor requires.
282 * Fixes an issue that prevented the offline patron registration
284 * Fixes an issue with searching patrons by permission group.
285 * The barcodes in the patron search are now clickable.
286 * Staff members can now manually override the patron juvenile
287 flag value, regardless of the patron's date of birth.
288 * Checkboxes on patron registration screen are now properly aligned
290 * The user permission group dropdowns in the patron registration,
291 edit, and search interfaces now have scrollbars.
292 * The date picker on the checkout screen is now hidden unless
293 circ staff activates a specific due date option.
294 * The check-in screen now includes a copy status column.
295 * The Merge Patrons interface now displays the date of birth.
296 * The user bucket screen now displays the Bucket ID.
297 * The payment button on patron bills screen is now inactive if the
298 Payment Received field is blank.
299 * The Bill History receipt now includes a Finish date and a Last
301 * When a patron summary contains an image of the patron,
302 that image tag now has a null alt attribute to remove it from
303 the flow of a screen reader.
304 * Corrects an issue that caused the transit dialog to show the
306 * Corrects an issue with printing transit lists.
307 * "Find another target" on transiting hold no longer leaves the
309 * The images now display to distinguish hold and transit slips.
310 * The Clearable Holds list printout now only shows holds that have
312 * Restores the call number prefix and suffix fields to the holds
314 * The documentation at the top of the hold shelf slip template
316 * The cursor in the in-house use screen now automatically goes
317 to the barcode field.
318 * The in-house use screen now shows a copy status column.
319 * Add support for converting change to patron credit in the patron bills
320 interface, consistent with the XUL feature.
321 * Fixes a bug that caused pickup/request library fields to be
323 * Fixes a bug in the offline org unit tree.
325 Command-line system administration
326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
328 * The novelist entry in `eg_vhost.conf` includes two new
330 * Corrects an issue with the `--max-sleep` argument on the
331 `action_trigger_runner.pl` support script.
332 * Corrects an issue with how the `eg_pbx_allocator.pl` script
333 detects an existing lock file.
334 * The 3.0.2-3.0.3 upgrade script disables triggers before
335 recalculating bib visibility.
340 * Fixes an issue that caused records with located URIs to be
341 retrieved in Copy Location and Copy Location Group searches.
342 * Fixes an error message that appeared in the search box
343 in the public catalog while placing hold after an advanced search.
344 * Restores the display of copy information for the user's
345 preferred library in the public catalog.
346 * Fixes regression errors in the search results page.
347 * Removes redundant call numbers from the Show More Details
349 * The cast field in the catalog is now taken from the 511 field
350 when first indicator = 1, rather than the 508.
351 * Fixes a display issue caused by editing holds.
356 * Fixes an issue that prevented users from searching for
357 receivable issues using Database ID or ISSN in the Serials
358 Batch Receive interface.
363 * Adds some padding to the bottom of Web Client interfaces.
364 * Logins now honor all org unit timeout settings.
365 * Evergreen will now identify and handle invalid timezones.
366 * Fixes an issue where a column header in some interfaces were automatically
367 highlighted in green when retrieving the interface.
368 * The parts column in the Item Status screen now displays parts data.
374 We would like to thank the following individuals who contributed code,
375 tests and documentation patches to the 3.0.8 point release of
410 This release contains bug fixes improving on Evergreen 3.0.6.
412 * Fixes a performance issue with the Patron Billing History screen and
413 other screens that cause Flattener.pm to re-create joins
415 * Fixes an issue that prevented patron alerts from showing to staff at
417 * Corrects the "Holdable" attribute display on the Item Status detailed
419 * Fixes the ability to delete multiple copies from Item Status.
423 We would like to thank the following individuals who contributed code,
424 tests and documentation patches to the 3.0.7 point release of
438 This release is a security release that fixes cross-site scripting
439 (XSS) vulnerabilities in the Evergreen public catalog. This release
440 also includes several other bugfixes improving on Evergreen 3.0.5.
442 Security Issue: XSS Vulnerability in Public Catalog
443 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
444 This release fixes several cross-site scripting (XSS) vulnerabilities
445 in the public catalog. When upgrading, Evergreen administrators should
446 review whether any of the following templates have been customized
447 or overridden. If so, either the template should be replaced with the
448 stock version or the XSS fix (which entails adding the `| html` filter
449 in several places) applied to the customized version.
451 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
452 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
453 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
455 Note that exploiting the XSS vulnerabilities fixed in this release
456 would require either the ability to create maliciously-constructed
457 MARC bibliographic or holdings records or the ability to set a
458 maliciously constructed organizational unit name.
462 Evergreen 3.0.6 also includes the following changes:
464 * When using 'Selection Lists -> Edit MARC Order Record' in the web
465 staff client, now only one click is required to save the MARC
466 record rather than two.
467 * The volume/copy editor in the web staff client now better handles
468 editing multiple items that have different sets of statistical
469 category values assigned to them.
470 * The act of merging bibliographic records now updates bookbags
471 that referred to the source bibliographic record rather than
472 effectively deleting entries for that record.
473 * Additional columns were added to the Holds Pull List in the
475 * The patron registration form in the web staff client now correctly
476 manages setting user preferences.
477 * An error in a pgTAP unit test was corrected.
481 We would like to thank the following individuals who contributed code,
482 tests and documentation patches to the 3.0.6 security release of
498 This release contains bug fixes improving on Evergreen 3.0.4.
500 * The MARC Editor in the Web staff client now wraps long fields.
501 * The MARC Editor no longer allows catalogers to enter new lines
503 * Fixes an issue that prevented serials items from being deleted or
505 * The Web staff client Check In screen no longer reloads the whole
506 page multiple times each time an item is scanned.
507 * Fixes an issue that displayed the oldest -- rather than the newest
508 -- transit in the Web staff client Item Status page.
509 * Fixes an issue that prevented the reports module from being displayed
511 * Fixes an issue in the Web staff client reports module that caused
512 syntax errors in reports that use virtual fields and joins.
513 * Fixes an issue that prevented several dropdown menus in the Web staff
514 client from activating.
515 * Fixes an issue that created duplicate copy data when copies or
516 volumes with parts were transferred.
517 * Fixes the Trim List feature in the Web staff client Check In screen.
518 * The Item Status grid now displays the Circulation Modifier.
519 * Restores missing data from the Profile column in Place Hold patron
521 * Fixes an issue with the http -> https redirect on Apache 2.4.
522 * Fixes an color contrast accessibility issue in the Web staff
523 client and adds underlining to links in grid cells for added accessibility.
524 * Adds automated regression and unit tests for the Web staff client
526 * Adds a process for spell-checking the official documentation.
527 * Adds a script that simplifies the release process related to translations.
532 We would like to thank the following individuals who contributed code,
533 tests and documentation patches to the 3.0.5 point release of
538 * Blake Graham-Henderson
553 This release contains bug fixes improving on Evergreen 3.0.3:
555 * Fixes a bug that caused all searches limited by shelving location to
557 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
558 rather than the ordering agency's SAN.
559 * Fixes a bug that prevented Safari/iOS users from logging in to the
561 * Fixes a bug that prevented users from using the browse interface.
562 * Fixes a bug in the Item Status List view that caused incorrect due
564 * Approval code is now a required field in the web client's patron
565 credit card payment form.
566 * Fixes a bug with credit card payments that caused a receipt to print
567 showing that the patron paid the bill when the payment had not actually
569 * Fixes a bug that prevented the EDI translator from being installed on
571 * Fixes a bug that caused entries to show up multiple times in the
572 Items Out and Holds tabs in the patron record.
573 * Fixes a bug that caused grids on Bills and Patron Messages
574 screens to not display properly.
575 * The following fields are now available for the Checkout and Items Out
582 ** money_summary.balance_owed
583 ** money_summary.total_paid
584 ** money_summary.total_owed
589 * The following fields are now available on the Bill Payment receipt templates:
599 * Payment type is now a column in the payments tab of the patron record
600 Bill History section.
601 * The "Replace Barcode" function now makes it more difficult for staff
602 members to attempt to create blank patron barcodes.
603 * The patron bills screen now prevents staff members from double-clicking
604 on the Apply Payment button (which otherwise would apply two payments).
605 * Fixes a bug that prevented patrons attached to statistical categories
606 from displaying in the patron search-to-hold dialog.
607 * Fixes a performance issue related to uploading CSV files of barcodes
608 to the item status and patron bucket interfaces.
609 * Fixes several small bugs in the Spanish translation.
610 * Fixes a performance bug related to patrons logging in by barcode.
614 We would like to thank the following individuals who contributed code,
615 tests and documentation patches to the 3.0.4 point release of
637 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
638 update the visibility attributes of all bibs that make use of Located URIs or
639 bib sources. It may take a while to run on large datasets. If it it running
640 too long, it can be canceled and the following psql commands will create and
641 run a script that will perform the same action serially over time without
642 blocking writes to bibs:
645 \o /tmp/luri_visibility_update.sql
646 SELECT 'UPDATE biblio.record_entry SET ' ||
647 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
648 'WHERE id = ' || id || '; SELECT ' || id || ';'
649 FROM biblio.record_entry
651 SELECT DISTINCT cn.record
652 FROM asset.call_number cn
654 AND cn.label = '##URI##'
657 FROM asset.uri_call_number_map m
658 WHERE m.call_number = cn.id
661 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
666 \i /tmp/luri_visibility_update.sql
669 It will output the id of each updated bib so that the script can be killed
670 and then edited to remove completed bibs. The remainder can be run at a
673 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
674 we do NOT update the bib's visibility attributes, as doing so causes a loop
675 and an eventual trigger stack violation. This flag should ONLY be used when
676 forcing reingest of record attributes (NOT visibility attributes), search,
677 facet, and display fields, so if using this flag under normal operation,
678 proceed at your own risk and know that Located URI and bib source changes
679 will not be reflected in the visibility attributes of the record.
683 This release contains several bug fixes improving on Evergreen 3.0.1:
685 * Fixes several issues related to the display of located URIs and records with
686 bib sources in search results.
687 * Setting `opac_visible` to false for a copy location group now hides only
688 the location group itself, rather than also hiding every single copy in the
690 * Fixes a bug that prevented the copy editor from displaying the _fine level_
691 and _loan duration_ fields.
692 * The "Edit Items" grid action in the Item Status interface will now open
693 in the combined volume/copy editor in batch. This makes the behavior
694 consistent with the "Edit Selected Items" grid action in the copy
696 * Staff members are now required to choose a billing type when creating a
697 bill on a user account.
698 * The Web client now provides staff users with an alert and option to
699 override when an item with the Lost and Paid status is checked in.
700 * Fixes a bug where the Web client offline circ interface was not able
701 to set its working location.
702 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
704 * The MARC editor in the Web staff client now presents bib sources in
706 * Both circulation and grocery bills are now printed when a staff user selects
707 a patron account and clicks "Print Bills".
708 * Fixes an issue in the XUL serials interface the "Receive move/selected"
709 action from succeeding.
710 * Fixes a typo in the user password testing interface.
714 We would like to thank the following individuals who contributed code,
715 tests and documentation patches to the 3.0.3 point release of
734 This release contains several bug fixes improving on Evergreen 3.0.1:
736 * Copy templates created in XUL Holdings Maintenance will now be
737 automatically converted and displayed in the web staff client's
739 * The list of report templates now includes a column indicating whether
740 the template was originally created in the XUL staff client or the web
741 staff client; staff need to know this since report templates created in
742 one interface cannot be edited in the other.
743 * Call number prefixes and suffixes are now displayed in various grids
744 in the web staff client, including
745 ** Pending Copy Buckets
747 ** Checkin/Capture Holds
749 ** Patron Bills History
756 ** Bib Record View Holds
758 * Many patron fields have been redacted from the web staff client's patron
759 and record holds grids, leaving patron name, username, and ID.
760 * Fixes two bugs where patron records could fail to be saved upon editing.
761 * The web staff patron editor now better warns staff users about
762 duplicate names, IDs, phone numbers, and email addresses.
763 * Human readable labels are now displayed for certain fields in standing
765 * The patron summary in the web staff client now correctly displays
766 primary and secondary ID values.
767 * The web staff client's billing full details page now displays
768 information about the staff user that created a payment.
769 * The web staff client now requires staff users to explicitly set a
770 billing type when adding a manual bill.
771 * The web staff client's patron bill annotation modal now works.
772 * Patron barcode search completion in the web staff client now allows
773 the user to select from all of the matching patron records.
774 * The Hold Shelf Slip print template in the web staff client now has
775 access to the call number.
776 * The Checkout Receipt print template in the web staff client now can
777 include summary financial information, incuding current balance, total
778 paid on outstanding fines, and total owed.
779 * The web staff print templates for current and historical bills can
780 now include copy barcode and title.
781 * Fixes a bug that resulted in some catalog searches unexpectedly
783 * Fixes a bug that resulted in catalog searches that specify a location
784 limit returning incorrect results.
785 * Fixes a bug where deleted copies could make records visible in the
787 * Fixes a bug where certain queries on copies used in the public catalog
789 * Fixes a bug place a hold request in the public catalog could result
790 in "forgetting" the type and library of the user's previous search.
791 * The web staff client now respects staff user session timeouts, and
792 will log out all open tabs if a user's session has timed out.
793 * The web staff Z39.50 page will now give the staff user an alert if
794 they attempt to import a record with a duplicate TCN.
795 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
796 entries from being deleted.
797 * Fixes a bug that made using the volume/copy editor to change a copy's
799 * The administration interface for hard due dates now ensures that
800 new (or edited) ceiling dates have their time component set to end
801 of day, resolving an issue where ceiling dates would not be applied
802 during the ceiling date itself.
803 * The web staff client can now include dynamic information in browser
804 tab titles, e.g., "Smith, Jane - Checkout".
805 * The Concerto sample data set now includes data allowing for testing
806 placing holds on monographic parts.
807 * Asset merging during bibliographic record merging now correctly
808 recognizes call number prefixes and suffixes and deletes disused
810 * Fixes a bug where displaying user surveys could result in PCRUD
812 * Fixes a bug where pg_restore of an Evergreen database could fail
813 to create certain indexes on the `actor.usr` table.
817 We would like to thank the following individuals who contributed code,
818 tests and documentation patches to the 3.0.2 point release of
849 This release contains several bug fixes improving on Evergreen 3.0.0
851 * Fixes a bug in the web staff client that prevented initials from being
852 stored with copy notes.
853 * Adds billing types that may have been missed by systems that were
854 running Evergreen prior to the 1.4 release.
855 * Fixes a web staff client bug with the CSV export option available from
856 the Import Queue in the MARC Batch Import/Export interface.
857 * Adds the missing copy alert field in the web client's volume/copy
859 * Fixes a bug where the setting to require date of birth in patron
860 registration was not being honored in the web staff client.
861 * Fixes a bug in the web staff client patron registration form where the
862 password wasn't generating from the last four digits of the patron's
864 * Fixes an issue in the web staff client where the complete barcode did
865 not display in some interfaces when partial barcodes were scanned.
866 * Fixes an HTML error in the new copy tags that display on the record
868 * Fixes a web staff client bug where recording a large number of in-house
869 uses at one time doesn't display a confirmation dialog once it hits the
871 * Adds a _Print Full Grid_ action in the web staff client
872 holds pull list to allow staff to print the entire pull list as it
873 displays on the screen. This change also changes the _Export CSV_ action
874 to an _Export Full CSV_ option.
875 * Fixes an issue with the Patron Messages interface that prevented it
876 from saving column configuration changes in the web staff client.
877 * Fixes a bug in the web staff client where a billing prompt did not
878 correctly display after marking an item damaged in those systems that
879 have enabled the setting to bill for damaged items.
880 * Adds an option to the specific due date feature that allows saving
881 that due date until logout. This allows all circulations from a given
882 workstation to be due on the same date.
886 We would like to thank the following individuals who contributed code,
887 tests and documentation patches to the 3.0.1 point release of
909 The minimum version of PostgreSQL required to run Evergreen 3.0 is
910 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
912 Change to Names of Shared Libraries
913 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
914 OpenSRF 3.0 changes how the shared libraries for services written in
915 C are named. If upgrading from an earlier version of Evergreen,
916 `opensrf.xml` should be edited so that shared library file names
917 listed in the `<implementation>` tag start with "lib". For example,
920 ---------------------------------------------------------------------
922 <language>C</language>
923 <implementation>oils_cstore.so</implementation>
924 ---------------------------------------------------------------------
926 should be changed to:
929 ---------------------------------------------------------------------
931 <language>C</language>
932 <implementation>liboils_cstore.so</implementation>
933 ---------------------------------------------------------------------
935 SIP Bugfix Requires SIPServer Upgrade
936 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
938 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
939 crash" requires that you also upgrade SIPServer with the fix for
940 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
941 SIP client problems." This means that if you use SIP2 with Evergreen,
942 you must also upgrade SIPServer to the latest commit in the Git
943 repository. Conversely, if you upgrade SIPServer to the latest commit
944 in Git, you must also upgrade Evergreen or, at least, apply the patch
945 for Launchpad Bug 1542495. These two patches are complementary and
946 cannot be applied independently of one another.
948 `open-ils.auth.login`
949 ~~~~~~~~~~~~~~~~~~~~~
950 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
951 API's in the `opensrf_core.xml` file.
956 ---------------------------------------------------------------------
957 --- a/Open-ILS/examples/opensrf_core.xml.example
958 +++ b/Open-ILS/examples/opensrf_core.xml.example
959 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
961 <match_string>open-ils.auth.authenticate.verify</match_string>
962 <match_string>open-ils.auth.authenticate.complete</match_string>
963 + <match_string>open-ils.auth.login</match_string>
964 <match_string>open-ils.auth_proxy.login</match_string>
965 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
966 <match_string>open-ils.actor.user.password</match_string>
967 ---------------------------------------------------------------------
971 Administrators of Evergreen who use RTL locales and who have customized
972 `style-rtl.css.tt2` should now incorporate their customizations into
975 Multi-Time Zone Installations
976 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
978 For Evergreen consortia that span more than one time zone, the following
979 query will adjust all historical, unaged circulations so
980 that if their due date field is pushed to the end of the day, it is done
981 in the circulating library's time zone, and not the server time zone.
983 It is safe to run this after any change to library time zones.
985 Running this is not required, as no code before this change has
986 depended on the time string of '23:59:59'. It is also not necessary
987 if all of your libraries are in the same time zone, and that time zone
988 is the same as the database's configured time zone.
997 for ou_id in select id from actor.org_unit loop
998 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
999 if new_tz is not null then
1000 update action.circulation
1001 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
1002 where circ_lib = ou_id
1003 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
1012 Deprecation of XUL staff client
1013 -------------------------------
1014 Starting with the release of 3.0.0, patches that fix XUL bugs will not
1015 be merged into master or backported unless they meet one or more of
1016 the following conditions:
1018 a. the bug is a security issue
1019 b. the bug involves the destruction of data
1020 c. the bug is a regression of functionality in the XUL staff client
1021 introduced by other work done to Evergreen
1023 Under no circumstances will XUL staff client feature enhancements be merged.
1025 This policy will continue through the 3.0.x and 3.1.x maintenance
1026 release cycles, and will become moot upon the release of 3.2.0, when
1027 the XUL staff client is slated to be entirely removed.
1036 Evergreen 3.0 features a new, modern staff client that runs in the web browser
1037 and can be used on desktop and mobile devices. All functional areas of the
1038 system, including circulation, cataloging, acquisitions, serials, reports,
1039 booking, administration, and offline circulation, are available in the new staff
1040 client. Chrome and Firefox are officially supported for use with the web client.
1042 Library staff will no longer need to download separate software to perform most
1043 actions in Evergreen. A Chrome plugin called Hatch will be available as a
1044 separate installation for workstations that require seamless, dialog-free
1045 printing to multiple printers.
1047 In addition to adding more portability and stability, the new staff client also
1048 presents a cleaner and more modern interface for users. By virtue of running in
1049 a browser, actions that users are accustomed to performing on other web sites
1050 should now be available in the Evergreen client.
1052 The old, XUL client will continue to be available to allow for a gradual
1053 transition to the browser-based client, but no new features will be added. The
1054 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1064 New EDI Order Generator
1065 ^^^^^^^^^^^^^^^^^^^^^^^
1070 . New database tables exist for configuring vendor-specific EDI order
1074 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1076 * `acq.edi_attr_set`
1077 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1079 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1080 the stock configuration found in the JEDI template.
1081 * `acq.edi_attr_set_map`
1082 ** Link between `edi_attr`s and `edi_attr_set`s.
1084 . EDI Attribute Sets are manged via a new (browser client only) configuration
1085 interface at 'Administration -> Acquisitions Administration -> EDI
1088 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1089 is not set, default values will be used. Links between an EDI account
1090 and an attribute set are managed in the EDI Accounts configuration
1093 . Local modifications to the stock EG JEDI template are managed by modifying
1094 and/or adding additional `edi_att_set`s as needed.
1096 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1097 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1099 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1100 definition is no longer required and can be disabled.
1105 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1106 specifies whether PO's generated via the account should be built using
1107 EDI attributes or fall back to traditional JEDI A/T template generation.
1109 This allows sites to activate EDI attributes on a per-account basis, making
1110 it possible to migrate piecemeal to EDI attributes. For the initial roll
1111 out of this new feature, no accounts will be configured to use EDI
1112 attributes by default.
1118 3 Day Courtesy Notice by SMS
1119 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1120 New optional SMS text notification to be sent out 3 days prior to the due
1121 date of any circulating item for patrons who have an SMS text number and
1122 carrier stored in their accounts. This action trigger is disabled by default,
1123 but can be enabled and modified by going into 'Administration -> Local Administration ->
1124 Notifications / Action Triggers'.
1126 You may wish to make use of granularity so that these messages are batched
1127 and sent at the same time each day.
1132 Add Description Field to Circulation and Hold Configuration Entries
1133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1134 The circulation and hold policy configuration rules now each have a
1135 description field. This allows administrators to add comments to
1136 describe the purpose of each rule.
1141 Apache Internal Port Configuration Option
1142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1143 Apache configuration now supports a new variable which allows admins to
1144 specify the port used by Apache to handle HTTP traffic. The value is
1145 used for HTTP requests routed from Perl handlers back to the same Apache
1146 instance, like added content requests. Use this when running Apache
1147 with a non-standard port, typical with a proxy setup. Defaults to "80".
1150 -------------------------------------------------------------------
1153 PerlSetVar OILSWebInternalHTTPPort "7080"
1156 -------------------------------------------------------------------
1161 Configurable Bib Record Display Fields
1162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1164 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1165 fields: 'Display Field?' and 'Display XPath'.
1167 When 'Display Field' is set to true, data from the field will be extracted
1168 from each record and added to a new table of display data for each bib
1171 If a value is present in the 'Display XPath' field, this XPath will be
1172 applied to the extracted data *after* the base XPath (from the 'XPath'
1173 field) is applied to each field.
1175 This data acts as a replacement for the various and sundry ways bib record
1176 data is currently extracted, including inline XPath in the TPAC, reporter
1177 views, real-time 'MVR' compilation from MODS, etc. and will be available
1178 to the user interface, notification templates, etc. for rendering bib
1181 The browser client gets a new service 'egBibDisplay' which is capable
1182 of translating the display field data from various formats into
1183 data more suitable for JavaScript usage.
1185 The database gets 3 new views for representing display data in various
1188 * `metabib.flat_display_entry`
1189 ** List of all display fields linked to their configuration.
1190 * `metabib.compressed_display_entry`
1191 ** Same as `metabib.flat_display_entry` except there's one row
1192 per display field type, with 'multi' rows compressed into
1193 JSON arrays. Non-multi fields are represented as JSON
1195 * `metabib.wide_display_entry`
1196 ** Tabular view of display field data, one column per well-known
1197 field. Values are represented JSON, consistent with
1198 `metabib.flat_display_entry`. The view does *not* contain locally
1199 configured display fields, as each field must be encoded in
1200 the view and IDL definition. This is essentially a replacement
1201 for `reporter.simple_record`.
1206 After making changes to display field configuration, it's possible to
1207 reingest only display field data in the database using the following:
1210 ---------------------------------------------------------------------
1211 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1212 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1213 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1214 ---------------------------------------------------------------------
1220 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1222 The existing permission was incorrectly created with a code of
1223 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1224 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1225 update changes the permission code to match what the event requires.
1231 Hold Targeter V2 Repairs and Improvements
1232 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1233 * Make the batch targeter more resilient to a single-hold failure.
1234 * Additional batch targeter info logging.
1235 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1236 * Removes the confusingly named `--target-all` option
1237 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1238 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1240 New --next-check-interval Option
1241 ++++++++++++++++++++++++++++++++
1242 Specify how long after the current run time the targeter will retarget
1243 the currently affected holds. Applying a specific interval is useful
1244 when the retarget-interval is shorter than the time between targeter
1247 For example, if the targeter is run nightly at midnight with a
1248 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1249 since the holds won't be processed again until 48 hours later. This
1250 ensures that the org unit closed date checks are looking at the correct
1253 This setting overrides the default behavior of calculating the next
1254 retarget time from the retarget-interval.
1256 New --soft-retarget-interval Option
1257 +++++++++++++++++++++++++++++++++++
1258 This is a replacement for (and rebranding of) the `--skip-viable` option.
1259 The new option allows for time-based soft-targeting instead simple binary
1260 on/off soft-targeting.
1262 How soft-targeting works:
1264 * Update hold copy maps for all affected holds
1265 * Holds with viable targets (on the pull list) are otherwise left alone.
1266 * Holds without viable targets are retargeted in the usual manner.
1272 New marc_export --descendants Option
1273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1275 The `marc_export` script has a new option, `--descendants`. This option
1276 takes one argument of an organizational unit shortname. It works much
1277 like the existing `--library` option except that it is aware of the
1278 org. tree and will export records with holdings at the specified
1279 organizational unit and all of its descendants. This is handy if you
1280 want to export the records for all of the branches of a system. You
1281 can do that by specifying this option and the system's shortname,
1282 instead of specifying multiple `--library` options for each branch.
1284 The `--descendants` option can be repeated, as the `--library` option can.
1285 All of the specified org. units and their descendants will be included
1286 in the output. It can also be combined with individual `--library`
1287 options when necessary.
1292 RTL and LTR Public Catalog Stylesheets Merged
1293 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1294 The RTL stylesheet for the public catalog,
1295 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1296 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1297 template will provide RTL or LTR styles based on the value of
1298 the `rtl` flag of the active locale. An `rtl` variable is also available
1299 in the template to allow the correct style to be chosen.
1304 Miscellaneous Improvements
1305 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1307 * If a filter is in effect in the Library Settings Editor,
1308 the filter will continue to be applied after a user
1309 changes the selected library.
1310 * Copy templates used for serials now correctly link to age
1311 protection rules and MARC item type values (for the
1312 "Circ as Type" field). During upgrade, the database update
1313 will set to NULL any age protection and circ as type fields
1314 in serial copy templates that do not point to defined values.
1319 Obsolete Internal Flag Removed
1320 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1322 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1323 flag was removed from the `config.internal_flags` table. It was
1324 rendered obsolete by the addition of the 3 flags to control the
1325 browse, search, and facet indexing.
1330 Tweaks to Caching/Expiry of Public Catalog Assets
1331 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1332 The default cache expiration time for static assets (e.g.,
1333 CSS, image, and JavaScript files) in the public catalog and
1334 the Kid's PAC has been increased to one year. Links to all
1335 such assets now have a cache-busting value tacked on as a
1336 query parameter. This value is refreshed when `autogen.sh` is
1337 run, but it can also be manually set by adjusting the
1338 `ctx.cache_key` Template Toolkit variable.
1343 Action/Trigger Events Data Purging
1344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1346 Action/Trigger event definitions have a new field called 'Retention
1347 Interval'. When an optional interval value is applied, events and
1348 template output data linked to the event definition will be deleted
1349 from the database once they reach the specified age.
1351 Retention Interval Restrictions for Passive Hooks
1352 +++++++++++++++++++++++++++++++++++++++++++++++++
1354 Restrictions are placed on retention interval values for event definitions
1355 using passive hooks to prevent data from being deleted while it's still
1356 needed by the system.
1358 The presence of event data is how the system knows not to send duplicate
1359 events. As long as a scenario exists where a duplicate event may be
1360 generated, the events must be retained.
1362 To apply a retention interval value to a passive-hook event definition:
1364 * The event definition must have a max_delay value.
1365 * The retention interval must be larger than the difference between
1366 the `delay` and `max_delay` values.
1368 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1369 interval must be greater than 3 days to ensure no duplicate events are
1370 created between the first event on day 7 and the end of the event validity
1376 A new `purge_at_events.sh` script is installed in the bin directory
1377 (typically `/openils/bin`) which should be added to CRON for regular
1380 NOTE: On large data sets, this script can take a long time to run and
1381 create higher than normal I/O load as it churns though the event and
1382 event_output tables. You may wish to run the script by hand the first
1383 time so it can be monitored. It can be run in psql like so:
1386 ---------------------------------------------------------------
1387 SELECT action_trigger.purge_events();
1388 ---------------------------------------------------------------
1390 NOTE: On *very* large data sets (10s to 100s of millions of event and
1391 event_output rows), it may be advisable to first repopulate the `event`
1392 and `event_output` tables with only the desired data before starting
1393 regular purges. This can be done, for example, using the copy to temp
1394 table, truncate source table, repopulate source table from temp table
1395 approach. This will be much faster than the `purge_events()` function
1396 in cases where most of the data will be purged.
1401 A number of `action_trigger.hook` entries which have always been treated
1402 as active hooks, though are configured as passive hooks, have been
1403 updated to properly reflect the non-passive-ness. This allows for
1404 simpler configuration of their retention interval values.
1410 Remove JSPAC Redirects
1411 ^^^^^^^^^^^^^^^^^^^^^^
1412 Future versions of Evergreen will no longer contain automatic redirects
1413 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1414 that the JSPAC is no longer supported. Existing sites, however, may
1415 wish to retain JSPAC redirects in their Apache configuration files since
1416 JSPAC URLs may still be used in the wild to access their catalogs.
1418 The original JSPAC URL redirects are all retained in the file
1419 `Open-ILS/examples/jspac_redirects.conf` for reference.
1429 New open-ils.auth.login API
1430 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1431 The `open-ils.auth` service has a new API for requesting an authentication
1432 token. It performs the same steps as the
1433 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1434 using the bare password. No intermediate password hashing is required.
1436 The paramaters are the same as the `.complete` call with a few modifications.
1438 1. Using the generic 'identifier' parameter in combination with the
1439 'org' parameter allows the API to reliably determine if an identifier
1440 value is a username or barcode. The caller is no longer required to
1441 make that determination up front.
1443 2. The 'nonce' parameter is no longer used.
1449 Batch Patron Contact Invalidation
1450 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1451 The following methods are used to mark patron contact fields
1452 as invalid by moving the invalid value to a standing penalty:
1454 * `open-ils.actor.invalidate.email`
1455 * `open-ils.actor.invalidate.day_phone`
1456 * `open-ils.actor.invalidate.evening_phone`
1457 * `open-ils.actor.invalidate.other_phone`
1459 These methods now accept a fifth argument specifying the value
1460 of the contact field, e.g., a specific phone number or email
1461 address. If supplied, and if a specific patron ID (the first
1462 argument) is not supplied, all patrons with that specific contact
1463 value will have it marked invalid.
1473 Pure-SQL catalog searching
1474 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1475 Public and staff catalog search is now both more accurate and faster
1476 by redesigning how the visibility of records is calculated.
1486 Authority Record and Headings Browse Improvements
1487 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1488 Various improvements are made to support for authority records
1489 and headings browsing:
1491 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1492 headings from authority records. Since the MODS and MADS stylesheets
1493 extract headings in similar ways, duplicate browse entries are now
1494 much less likely to occur.
1495 * A new configuration table, `authority.heading_field`, is now used
1496 to specify how headings should be extracted from authority records.
1497 * Related headings can now be identified as narrower or broader when
1498 browsing in the public catalog.
1499 * See references are now more reliably included in the browse list.
1500 * Scope (public) notes now display only under the main heading.
1501 * There is now a global flag, Display related headings (see-also) in browse,
1502 that can be used to control whether related headings (see-alsos) are
1503 displayed in the public catalog list.
1504 * A complete set of thesauruses are now included in the seed data. Thesauruses
1505 can now be identified using short and long codes.
1506 * The labels for see and see-also references in the public catalog are
1507 a bit more patron-friendly, and can now be tweaked via TPAC template
1508 customization in the browse.tt2 file.
1514 Copy Tags and Digital Bookplates
1515 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1516 Copy tags will allow staff to apply custom, pre-defined labels or tags
1517 to copies. Copy tags are searchable in both the staff client and public
1518 catalog. This feature was designed to be used for Digital Bookplates to
1519 attach donation or memorial information to copies, but may be used for
1520 broader purposes to tag items.
1522 Each copy tag can either be publicly-visible or visible only to staff.
1523 Copy tags also have types that can be used for restricting catalog
1524 searches on copy tags to particular types.
1526 Copy tags are displayed in the copy table in the record summary page in
1527 the public catalog, and a new library setting can be used to add
1528 a "Digital Bookplate" search field. Copy tags can also be used
1529 as a search filter, e.g.,
1531 * `copy_tag(bookplate, jane smith)`: search for records that have a
1532 copy tag of type 'bookplate' whose value contains 'jane smith'.
1533 * `copy_tag(*, jane smith)`: search for records that have a
1534 copy tag of any type whose value contains 'jane smith'.
1536 All staff-side interfaces related to copy tags exist only in the web
1537 staff client. There are two new administration interfaces for managing
1538 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1539 button for applying copy tags to copies; that interface can also be
1540 used to create new copy tags on the fly. Furthermore, the copy buckets
1541 interface now has an 'Apply Tags' action for assigning tags to groups
1547 Two new permission are included:
1549 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1550 'Administration -> Server Administration -> Copy Tag Types'
1551 * `ADMIN_COPY_TAG`: required to create a new tag under
1552 'Administration -> Local Administration -> Copy Tags'
1554 The existing permission `UPDATE_COPY` controls whether or not a user
1555 can link copies to tags.
1559 A new library setting, 'Enable Digital Bookplate Search', controls
1560 whether to display a 'Digital Bookplate' field in the search index
1561 drop-downs in the catalog. A 'Digital Bookplate' search will include
1562 all records that have a copy that matches the tag specified by the user.
1563 It should be noted that this library setting does not affect the
1564 display of copy tags on the catalog record summary page.
1569 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1570 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1571 The call number prefix and suffix, when present, are now included in
1572 subfields $k and $m of the 852 field when running `marc_export` with
1573 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1574 server configured to embed item data in 852 fields, the affixes are now
1575 included in subfields $k and $m.
1585 Batch Editing of Patron Records
1586 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1587 There is a now a new interface analogous to the Copy Bucket interface
1588 to select and group a set of users into a User Bucket.
1589 The addition of users to a User Bucket is possible from the Patron Search
1590 interface by the use of a new grid Action, and directly on the User Bucket
1591 interface by user barcode. It is also possible to add users to a User
1592 Bucket by uploading a text file that contains a list of user barcodes.
1594 From this interface it is possible to perform a set of specific batch update
1595 operations on user records.
1600 These fields can now be changed in batch via an action on the User Bucket
1601 grid if the staff user has the `UPDATE_USER` permission:
1604 * Primary Permission Group (group application permissions consulted)
1606 * Home Library (`UPDATE_USER` checked against both old and new value)
1607 * Privilege Expiration Date
1608 * Barred flag (`BAR_PATRON` permission consulted)
1609 * Internet Access Level
1611 Changes made in this interface can be rolled back.
1613 As a batch process, rather than a direct edit, this mechanism explicitly skips
1614 processing of Action/Trigger event definitions for user update.
1619 The batch edit mechanism also allows for the batch deletion of user. The staff
1620 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1622 Changes made in this interface can be rolled back.
1624 As a batch process, rather than a direct edit, this mechanism explicitly skips
1625 processing of Action/Trigger event definitions for user deletion.
1627 This mechanism does not use the Purge User functionality, but instead simply
1628 marks the users as deleted.
1630 Editing Statistical Category Entries
1631 ++++++++++++++++++++++++++++++++++++
1633 All users in the bucket can have their Statistical Category Entries
1634 modified. Unlike user data field updates, modification of Statistical
1635 Category Entries is permanent and cannot be rolled back.
1637 As a batch process, rather than a direct edit, this mechanism explicitly skips
1638 processing of Action/Trigger event definitions for user update.
1640 New Service Requirement
1641 +++++++++++++++++++++++
1643 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1644 unused in production. If this service has been removed from the configuration
1645 of a live Evergreen instances, it will need to be added back in order for
1646 batch user editing to succeed.
1651 Honor Timezone of the Acting Library
1652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1657 * Display day-granular due dates in the circulating library's timezone.
1658 * Only display the date portion of the due date for day-granular circulations.
1659 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1660 * Provide infrastructure for more advanced formatting of timestamps.
1661 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1666 This is a followup to the work done for 2.12, where we added the ability
1667 for the client to specify a timezone in which timestamps should be interpreted
1668 in business logic and the database.
1670 Most specifically, this work focuses on circulation due dates and the closed
1671 date editor. Due dates, where displayed using stock templates (including
1672 receipt templates) and used for fine calculation, are now manipulated in the
1673 library's configured timezone. This is controlled by the new 'lib.timezone'
1674 setting available via the Library Settings Editor, loaded from the server when
1675 required. Additionally, closings are recorded in the library's timezone so that
1676 due date calculation is more accurate. The closed date editor is also
1677 taught how to display closings in the
1678 closed library's timezone. Closed date entries also explicitly record if they
1679 are a full day closing, or a multi-day closing. This significantly simplifies
1680 the editor, and may be useful in other contexts.
1682 To accomplish this, we use the moment.js library and the moment-timezone addon.
1683 This is necessary because the stock AngularJS date filter does not understand
1684 locale-aware timezone values, which are required to support DST. A simple
1685 mapper translates the differences in format values from AngularJS date to
1688 Of special note are a set of new filters used for formatting timestamps under
1689 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1690 filters provide the functionality, and autogrid is enhanced to make use of
1691 these where applicable. egGrid and egGridField are also taught to accept
1692 default and field-specific options for applying date filters. These filters may
1693 be useful in other or related contexts.
1695 The egDueDate filter, used for all existing displays of due date via Angular
1696 code, intentionally interprets timestamps in two different ways WRT timezone,
1697 based on the circulation duration. If the duration is day-granular (that is,
1698 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1699 of seconds) then the date is interpreted as being in the circulation library's
1700 timezone. If it is an hourly loan (any duration that does not meet the
1701 day-granular criterium) then it is instead displayed in the client's timezone,
1702 just as all other timestamps currently are, because of the previous Evergreen
1705 The public catalog is adjusted to always display the due date in the circulating
1706 library's timezone. Because the public catalog displays only the date portion of the due
1707 date field, this difference is currently considered acceptable. If this proves
1708 to be a problem in the future, a minor adjustment can be made to match the
1709 egDueDate filter logic.
1711 Now that due dates are globally stored in the configured timezone of the
1712 circulating library, the automatic adjustment to day-granular due dates needs
1713 to take those timezones into account.
1715 An optional SQL command is provided by the upgrade script to retroactively
1716 adjust existing due dates after library configuration is complete.
1722 Enhancements to Hard Due Date Functionality
1723 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1724 It will now be possible to delete Hard Due Date Values for dates that have
1725 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1726 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1727 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1732 Patron Search by Birth Date
1733 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1734 * Now you can include the patron birth year and/or birth month and/or
1735 birth day when searching for patrons using the web staff client.
1736 * Day and month values are exact matches. E.g. month "1" (or "01")
1737 matches January, "12" matches December.
1738 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1739 1915, 1599, etc. For exact matches use the full 4-digit year.
1743 Patron Search from Place Hold
1744 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1745 This feature allows staff members, when placing a
1746 hold on behalf of a patron in the web staff client, to search for
1747 patrons by names and other searchable patron information, rather than
1748 relying on barcode alone. In particular, after performing a catalog
1749 search or going to a specific bib record and clicking the 'Place Hold'
1750 button, the form now includes a 'Patron Search' button. This button
1751 will open a dialog allowing the staff member search for and select
1757 Retrieve Recent Patrons
1758 ^^^^^^^^^^^^^^^^^^^^^^^
1760 Adds a new library setting 'Number of Retrievable Recent Patrons'
1761 ('ui.staff.max_recent_patrons') that specifies the number of recently
1762 retrieved patrons that can be re-fetched from the staff client.
1764 A value of 0 means no recent patrons can be retrieved.
1765 A value greater than 1 means staff will be able to retrieve multiple
1766 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1768 The default value is 1 for backwards compatibility.
1775 Fuller title in XUL client Simplified Pull List
1776 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1777 The Simplified Pull List in the XUL client will now display subfields 245$n and
1778 $p in the title field. The addition will make it easier for staff to distinguish
1779 between different parts or seasons in a series.
1785 Transit Cancel Time and Terminology Change
1786 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1791 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1792 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1793 are preserved in the database, though still not visible to the end user in the staff client.
1794 This allows for better tracking of when transits are canceled for the purposes of knowing
1795 which staff member canceled the transit, etc.
1797 NOTE: This change may require the re-creation of transit reports to filter out canceled
1798 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1799 Is NULL' will suffice.
1801 "Canceled Transit" Terminology Change
1802 +++++++++++++++++++++++++++++++++++++
1804 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1805 For internal continuity, however, the following permission codes have not changed:
1808 * `ABORT_REMOTE_TRANSIT`
1809 * `ABORT_TRANSIT_ON_LOST`
1810 * `ABORT_TRANSIT_ON_MISSING`
1818 Offline Circulation Available in Web Staff Client
1819 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1820 Offline circulation is now available in the web staff client. In order to use the
1821 offline interface, users must first log into the web staff client, perform
1822 a patron search, select a user from the results, and open the patron editor
1823 interface to collect all the relevent configuration information for the
1824 workstation. In addition, the offline interface available from the Circulation
1825 menu provides a 'Download block list' button for users who are logged in.
1827 As is the case in the old staff client, users can check materials in and out,
1828 renew items, and create new patron accounts while offline. The patron fields
1829 available in the offline patron registration editor are the same ones that
1830 are available to staff when working online.
1834 Add Circ Modifier to Record Detail Page in Staff TPAC
1835 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1836 The circulation modifier field is added to the table of copies to make
1837 more information available to staff without having to open
1844 Date+Time Format Settings for Web Client
1845 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1847 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1848 and adds two settings for use with the webstaff client:
1850 * 'Format Dates with this pattern'
1851 * 'Format Date+Time with this pattern'
1853 These settings use format strings as documented here:
1855 https://docs.angularjs.org/api/ng/filter/date
1857 There is overlap with how the Dojo formats worked, but also some differences.
1859 The original 'Format Dates' and 'Format Times' settings worked together, but the
1860 new settings work independently. Certain field elements will use one, and
1861 certain field elements will use the other. These distinctions are hard-coded
1862 in the various UI templates, with the idea being that timestamp fields in
1863 which the date component alone is sufficient information (for example, date of birth)
1864 will use the 'Format Dates' setting. Fields where the time component is
1865 important (for example, checkout time) will use the 'Format Date+Time' setting.
1867 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1868 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1874 Global Option to Remove Sound for a Specific Event
1875 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1876 A new `nosound.wav` file has been added to the web client. The file can be used
1877 to globally disable audio alerts for a specific event on an Evergreen system.
1879 For example, to silence the alert that sounds after a successful patron search:
1883 mkdir -p /openils/var/web/audio/notifications/success/patron/
1884 cd /openils/var/web/audio/notifications/success/patron/
1885 ln -s ../../nosound.wav by_search.wav
1892 The official Evergreen manual has been split into eight new manuals, each
1893 designed for a specific audience. This new approach is designed to make
1894 the documentation more readable and usable.
1896 The specific audiences for the new manuals are:
1898 * Acquisitions staff
1901 * Public services staff who use the public catalog
1903 * System administrators who use the command line
1904 * System administrators who use the Web client
1905 * System administrators and programmers who wish to integrate Evergreen
1906 with other technologies
1908 All manuals are available at http://docs.evergreen-ils.org
1914 Improvements to ebook API
1915 ^^^^^^^^^^^^^^^^^^^^^^^^^
1917 Evergreen now supports checking out and placing holds on
1918 OverDrive and OneClickdigital ebook titles from within the public
1919 catalog. This is an experimental feature. It is not recommended for production
1920 use without careful testing.
1922 When ebook integration is enabled, a "Check Out E-Item" link will be
1923 displayed when viewing an ebook title from a supported vendor in the
1924 catalog. Clicking on the link allows the user to check out and download
1925 that title from the vendor directly within the catalog.
1927 If no copies are available for the title, a "Place Hold on E-Item" link
1928 is displayed instead, and the user may place a hold on the title. (Note
1929 that some vendors require the user's account to have an email address
1930 before permitting a hold.)
1932 My Account includes the ability to view current ebook checkouts and
1933 holds, download already-checked-out titles, and cancel holds.
1935 For API integration to work, you need to request API access from the
1936 vendor, and the vendor must have a way of authenticating your patrons.
1937 Your Evergreen system also needs to be configured for ebook API
1938 integration, following the instructions in the command line system
1939 administration manual
1942 This feature assumes that you are importing MARC records supplied by the
1943 vendor into your Evergreen system, using Vandelay or some other MARC
1944 import method. This feature does not search the vendor's online
1945 collections or automatically import vendor records into your system; it
1946 merely augments records that are already in Evergreen.
1948 Improvements to Bill Payment Pages
1949 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1950 The bill payment pages in the public catalog have been revamped
1953 * use the term "charges" instead of "fees"
1954 * include images of credit cards accepted
1955 * make the default print receipt template match other itemized receipts;
1956 note that this change is not automatically applied when upgrading.
1957 * display billing type
1958 * add button to pay only selected charges
1959 * reformat the credit card number input page
1965 Clickable Copy Locations
1966 ^^^^^^^^^^^^^^^^^^^^^^^^
1967 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1968 the associated copy location will display as a link in the public catalog summary display.
1969 This link can be useful for retrieving maps or other directions to the copy
1970 location to aid users in finding material.
1975 Download Checkout History CSV Fixed for Large Number of Circulations
1976 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1977 Downloading checkout history as a CSV from My Account has been fixed
1978 for users with a large circulation history. Previously, this would
1979 time out for patrons with more than 100 or so circulations.
1981 This feature no longer uses the action/trigger mechanism and the public catalog
1982 now generates the CSV directly. The old action/trigger code is still
1983 present in the database and should be removed at some point in the
1989 Google Books Preview Rewrite
1990 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1991 The Google Books Preview functionality in record detail pages has been
1992 rewritten to modernize its style and optimize its performance:
1994 * The Dojo JavaScript framework is no longer used, saving approximately
1995 150K of JavaScript and CSS and four network requests per page load.
1996 * The Embedded Viewer is not loaded unless a possible preview is found,
1997 saving more network and memory overhead.
1998 * The Google Books Loader is used to load the Embedded Viewer instead of the
1999 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
2001 * All variables are self-contained and do not pollute the global namespace.
2002 * Event listeners are registered to handle clicks, rather than attaching
2003 `href="javascript:function()"` to <a> elements.
2004 * Book previews are displayed in a panel sized according to the viewport
2005 of the browser, improving its appearance on both mobile and desktop
2007 * The rewritten code is now served up directly from
2008 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
2013 jQuery for the Public Catalog
2014 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2015 This release adds optional support for jQuery in the public catalog. This support
2016 is enabled by setting the `ctx.want_jquery` variable to a true value in the
2017 `config.tt2` template.
2023 New Popularity Parameters
2024 ^^^^^^^^^^^^^^^^^^^^^^^^^
2025 New popularity parameters for in-house use over time and for count of distinct
2026 organizational units that own a title are now available. Evergreen sites
2027 can use these parameters to create new statistical popularity badges for
2028 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
2030 The in-house use parameters will apply a badge to titles that have the most
2031 in-house use activity over time. The organizational unit count parameter
2032 will apply a badge to titles owned by the most number of libraries in a
2033 consortium. Ownership is determined by the copy's circulation library.
2038 Option to Suspend Holds at the Time They are Placed
2039 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2040 Users now have the option to suspend a hold at the same time they place the
2041 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
2042 who want to suspend a hold at the time it is placed. There is also an option
2043 to set the activation date at the same time. This option is also available
2044 when placing holds on a batch of titles from 'My List' and will apply to
2045 all the titles in the batch.
2056 Fix to reporter.classic_current_circ View
2057 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2058 The `reporter.classic_current_circ` view, which is part of some
2059 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
2060 has been fixed to not exclude loans for patrons who do not have a
2061 billing address set. Users of this view should rerun
2062 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2067 New Report Source Table Allowing Report of "Last" Deleted copy
2068 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2070 This source table allows you to construct a clever aggregate report template
2071 which will report bibliographic IDs where a library or a group of libraries
2072 no longer have a copy attached but *had* a copy attached. This is especially
2073 useful when a holdings sync is required with an external vendor.
2076 Instructions for creating a report template with this source:
2078 * Create a new report template using "Library Holdings Count with Deleted" as the source
2079 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2080 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2081 * 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"
2082 * Add "Bib ID" to Displayed Fields
2083 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2084 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2085 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2088 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2089 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2090 specified date range. Unfortunately the user will have to manually type the date range without the date
2091 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2092 copy and more than two deleted copies."
2097 Add Provider to Provider Note Link
2098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2099 The Provider reporting source now includes a link to the Provider Note reporting source.
2104 Link ILS User and Working Location Reporting Sources
2105 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2106 The Working Location reporting source now has labels
2107 and it is now linked to the ILS User reporting source, allowing
2108 reports to display or filter on staff working location.
2113 New Circulation Report Source "All Circulation Combined Types"
2114 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2116 This report source will allow you to create a single report template for all of the following:
2119 * In-house uses of non-cataloged items
2121 * Circulations of non-cataloged items
2123 To distinguish between these different types of library use, it's important to display these columns
2124 in your report templates:
2133 Reports Template Searching
2134 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2135 A new form appears along the top of the reports interface for searching
2136 report templates. Once found, typical template actions (e.g. create new
2137 report) are available from within the results interface.
2139 Searches may be performed across selected (visible) folders or all
2140 folders visible to the logged in user.
2142 Searches are case-insensitive, any word order, with left-anchored words.
2143 All searched words must appear in at least one of the searched fields.
2148 * Searching for 'stat cat' matches:
2150 ** statistical category
2151 ** categories, statistical
2152 ** patrons (stat cat)
2153 * Searching for 'stat cat' does not match:
2155 *** both words must be present in the searched field(s)
2157 *** location contains 'cat' but it's not left-anchored.
2162 The templates, reports, and output interfaces now support paging via
2163 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2175 Web Staff Client Serials Module
2176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2177 The serials module has been ported over to the web staff
2178 client, implementing a unified serials interface that combines
2179 ideas from both the serial control view and alternate serials
2180 control view from the old staff client.
2182 In addition to carrying over functionality that was available
2183 in the old staff client, several new features are included:
2185 * the ability to save prediction pattern codes as templates
2186 that can be shared and reused within an Evergreen database
2187 * a more streamlined interface for managing subscriptions,
2188 distributions, and streams
2189 * it is no longer necessary to create a starting issue in
2190 order to predict a run of issues; the dialog box for
2191 generating a set of predicted issues now lets you specify
2192 the starting point directly.
2193 * the ability to more directly edit MFHDs
2195 The new serials interfaces can be accessed from the record
2196 details page via a Serials drop-down button that links to
2197 a subscription management page, a quick-receive action, and
2198 a MFHD management page. There is also a new 'Serials Administration'
2199 page where prediction pattern and serial copy templates can
2210 SIP Bugfix Changes How Encoding Is Determined in Configuration
2211 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2213 The combined fix for the above mentioned SIP bugs alters the way that
2214 SIPServer looks up the output encoding in the configuration file (typically
2215 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2218 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2219 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2220 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.
2221 4. If none of the above exist, then the default encoding (ASCII) is used.
2223 Number 3 is provided to ease the transition to the new code. It is
2224 the current location of the +encoding+ element in the sample
2225 configuration file and as such, where it is likely to be found in
2226 actual files. It is recommended that you alter your configuration to
2227 move this element out of the +implementation_config+ element and into
2228 its parent +institution+ element. Ideally, SIPServer should *not* look into
2229 the implementation config, and this check may be removed at some time
2237 Web Client Acknowledgments
2238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2240 The project to develop a new browser-based web client launched four
2241 years ago at the September 2013 Evergreen developer hack-a-way when the
2242 developer community voted to move away from the XUL client and explore other
2243 platforms. The first web client preview became available in Evergreen 2.7 when
2244 circulation was available in the new platform.
2246 The browser-based client is available due to the work of many coders, testers,
2247 bug reporters, documentors, translators, project managers, spec writers, funders
2248 and other contributors over the past four years.
2250 The Evergreen project would like to acknowledge the following organizations
2251 that funded development of the Web Staff Client:
2254 * British Columbia Libraries Cooperative
2255 * Consortium of Ohio Libraries
2257 * Georgia Public Library Service
2258 * Grand Rapids Public Library
2260 * Kenton County Public Library
2261 * King County Library System
2264 * Pennsylvania Integrated Library System
2265 * Pioneer Library System
2268 The Evergreen project would also like to thank the following individuals who
2269 contributed code, translations, documentation patches, tests, bug reports,
2270 technical specifications, and project management to the Web Staff Client:
2307 * Freddy Enrique Pelayo Huapalla
2333 Evergreen 3.0 Acknowledgments
2334 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2336 The Evergreen project would like to acknowledge the following
2337 organizations that commissioned developments in this release of
2341 * British Columbia Libraries Cooperative (BC Sitka)
2343 * Georgia Public Library Service
2344 * King County Library System
2346 * Pennsylvania Integrated Library System
2347 * Pioneer Library System
2349 We would also like to thank the following individuals who contributed
2350 code, translations, documentation patches, and tests to this release of
2399 We also thank the following organizations whose employees contributed
2402 * British Columba Libraries Cooperative
2406 * Emerald Data Networks, Inc.
2407 * Equinox Open Library Initiative
2409 * Grand Rapids Public Library
2410 * Indiana State Library
2412 * King County Library System
2413 * Lake Agassiz Regional Library
2414 * Laurentian University
2415 * Linn-Benton Community College
2417 * Merrimack Valley Library Consortium
2419 * North of Boston Library Exchange
2420 * Pennsylvania Integrated Library System
2421 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2423 * Traverse Area District Library
2425 We regret any omissions. If a contributor has been inadvertently
2426 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob