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 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
15 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
16 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
17 * Fixes various misspellings and capitalization issues in the interface.
18 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
19 * Fixes an issue with checking in hourly loans.
20 * Staff can now approve pending patron addresses in the patron edit interface.
21 * Prevents patron records from being merged with themselves.
22 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
23 * Fixes issues with duplicate transit records.
24 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
25 * Improvements to the Item Attribute Editor.
26 * Staff can now set a default search box in the Z39.50 search interface.
27 * Staff can now delete copy notes.
28 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
29 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
30 * Protects backordered acquisitions items from having their catalog items deleted.
31 * Fixes problems that occur when cloning a report template created in the XUL client.
32 * Fixes bugs that caused activity metric data when performing searches.
33 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern.
34 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
38 We would like to thank the following individuals who contributed code,
39 tests and documentation patches to the 3.0.12 point release of
68 This release contains bug fixes improving on Evergreen 3.0.10.
69 All bug fixes refer to the web staff client unless otherwise specified.
74 * Several strings are now displayed in the correct translation.
75 * Right clicking in grids results in more intuitive behavior.
76 * Usernames and barcodes containging the _%_ character no longer
77 experience problems logging in.
78 * Fixes cases in which the web client stops loading after the toolbar.
79 * Fixes problems in which using the web client in multiple tabs leads
80 to data inconsistency.
81 * Fixes an issue that caused authentication session checks to spam
82 the system and needlessly fill up logs.
83 * Boolean fields within grid views now say "Yes"/"No" instead of
85 * Fixes sorting issues in the patron search.
86 * Staff can now choose to print out only a selection of items out,
87 instead of having to print them all.
88 * The patron triggered event screen now respects the
89 `circ.staff.max_visible_event_age` library setting.
90 * Fixes an issue which caused an exception to be thrown during
91 non-cataloged item checkout.
92 * Fixes permission issues related to merging users.
93 * The bibliographic record summary now displays the call number that
94 matches the library's classification system.
95 * The copy editor now makes shelving locations visible to catalogers
96 from other libraries as needed.
97 * Once a record is overlayed in the Z39.50 screen, it is no longer
99 * Several fixes to the filters on the Holdings View screen.
100 * Several fixes to how empty volumes are created and displayed.
101 * Fixes to item and call number transfers.
102 * Fixes several issues with the item status list view.
103 * When adding new copies, the circulation library now defaults to the
104 call number's owning library.
105 * Fixes display issues with the Print Item Labels page.
106 * Fixes an issue in which the staff client and the OPAC displayed
107 different counts of available items.
111 We would like to thank the following individuals who contributed code,
112 tests and documentation patches to the 3.0.11 point release of
132 This release contains bug fixes improving on Evergreen 3.0.9. Note that
133 all bug fixes refer to the web staff client unless otherwise specified.
138 * Fixes right-click issues with the Web client grids
139 * Fixes an issue with the Default SMS Carrier in the patron edit form.
140 * Fixes an issue that allowed overdue notices to be sent to a patron
141 whose long overdue item has been paid for.
142 * Checking in precat items now displays the "Route to Cataloging" alert each
143 time the item is checked in.
144 * Fixes an issue in which the Adjust to Zero feature
145 does not close a checked-in lost circ.
146 * Deleted copies that are still checked out can now be checked in.
147 * Fixes a mislabeled column in the patron checkout grid.
148 * Fixes an error with the missing pieces functionality.
149 * Courier codes now display in the transit slip receipt preview.
150 * The Item Status grid now displays OU shortnames instead of full names
151 for the "Circulation Library" column.
152 * The Volume/Copy editor now allows users to remove a value from the Age
153 Hold Protection field.
154 * Barcode completion now works in copy buckets.
155 * The Z39.50 interface now notices when another record has been marked
157 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
158 the Z39.50 interface.
159 * Fixes a performance issue for the Validate button in the MARC Editor.
160 * Fixes an incorrect close tag in the Print Item Labels toolbar.
161 * Better scoping of copy tags in search results.
162 * Electronic Resource links now open in a new tab.
163 * Fixes an issue with the fiscal year close-out operation.
164 * Improves serials item deletes.
168 We would like to thank the following individuals who contributed code,
169 tests and documentation patches to the 3.0.10 point release of
194 This release contains bug fixes improving on Evergreen 3.0.8. Note that
195 all bug fixes refer to the web staff client unless otherwise specified.
200 * Fixes specific cases in which deleted records appear in search results.
201 * Fixes a performance issue with deleting patrons.
202 * The hold shelf dialog popup now lists the patron's notification
204 * Fixes an issue that prevented editing items when a monograph part
206 * Patron information is now available for use in the bills_current
207 and bills_historical receipt templates.
208 * The browser's "This page may contain unsaved data" warning now
209 appears when users click the update
210 expire date button in a patron account and attempt to navigate away
212 * The holds tab of the patron record now includes a monograph part
214 * The barcode box in the checkout screen
215 no longer hovers above patron record tabs when
216 staff users scroll down.
217 * Fixes an issue with the date of birth in the patron edit scren.
218 * Fixes an issue with the dropdown of billing type options.
219 * The Item Status screen now includes as a floating group column.
223 We would like to thank the following individuals who contributed code,
224 tests and documentation patches to the 3.0.9 point release of
227 * BC Libraries Cooperative
233 * Blake Graham-Henderson
250 This release contains bug fixes improving on Evergreen 3.0.7. Note that
251 all bug fixes refer to the web staff client unless otherwise specified.
259 * The MARC editor now handles 008 fields better.
260 * Adds spaces between subfields when suggesting a call
261 number for a new volume.
262 * MarcXML exports from the MARC Batch Import/Export ->
263 Export Records screen now downloads the file, rather than opening
265 * The Item Status Circulation Library column now displays a
266 shortname rather than the full library name.
267 * The Item Status Remaining Renewals column now displays
269 * The Item Status now has a "Last Renewal Workstation" column
271 * Fixes the circulation counts displayed in Item Status Details.
272 * Fixes an issue where multiple copies with different values for required
273 statistical categories could not be edited and saved in batch.
274 * Add an option to remove floating in the copy editor.
275 * Fixes an issue with the floating dropdown in the copy editor.
276 * Fixes a problem in which the copy template didn't properly copy
278 * Reduces the number of API calls that the MARC Editor requires.
283 * Fixes an issue that prevented the offline patron registration
285 * Fixes an issue with searching patrons by permission group.
286 * The barcodes in the patron search are now clickable.
287 * Staff members can now manually override the patron juvenile
288 flag value, regardless of the patron's date of birth.
289 * Checkboxes on patron registration screen are now properly aligned
291 * The user permission group dropdowns in the patron registration,
292 edit, and search interfaces now have scrollbars.
293 * The date picker on the checkout screen is now hidden unless
294 circ staff activates a specific due date option.
295 * The check-in screen now includes a copy status column.
296 * The Merge Patrons interface now displays the date of birth.
297 * The user bucket screen now displays the Bucket ID.
298 * The payment button on patron bills screen is now inactive if the
299 Payment Received field is blank.
300 * The Bill History receipt now includes a Finish date and a Last
302 * When a patron summary contains an image of the patron,
303 that image tag now has a null alt attribute to remove it from
304 the flow of a screen reader.
305 * Corrects an issue that caused the transit dialog to show the
307 * Corrects an issue with printing transit lists.
308 * "Find another target" on transiting hold no longer leaves the
310 * The images now display to distinguish hold and transit slips.
311 * The Clearable Holds list printout now only shows holds that have
313 * Restores the call number prefix and suffix fields to the holds
315 * The documentation at the top of the hold shelf slip template
317 * The cursor in the in-house use screen now automatically goes
318 to the barcode field.
319 * The in-house use screen now shows a copy status column.
320 * Add support for converting change to patron credit in the patron bills
321 interface, consistent with the XUL feature.
322 * Fixes a bug that caused pickup/request library fields to be
324 * Fixes a bug in the offline org unit tree.
326 Command-line system administration
327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
329 * The novelist entry in `eg_vhost.conf` includes two new
331 * Corrects an issue with the `--max-sleep` argument on the
332 `action_trigger_runner.pl` support script.
333 * Corrects an issue with how the `eg_pbx_allocator.pl` script
334 detects an existing lock file.
335 * The 3.0.2-3.0.3 upgrade script disables triggers before
336 recalculating bib visibility.
341 * Fixes an issue that caused records with located URIs to be
342 retrieved in Copy Location and Copy Location Group searches.
343 * Fixes an error message that appeared in the search box
344 in the public catalog while placing hold after an advanced search.
345 * Restores the display of copy information for the user's
346 preferred library in the public catalog.
347 * Fixes regression errors in the search results page.
348 * Removes redundant call numbers from the Show More Details
350 * The cast field in the catalog is now taken from the 511 field
351 when first indicator = 1, rather than the 508.
352 * Fixes a display issue caused by editing holds.
357 * Fixes an issue that prevented users from searching for
358 receivable issues using Database ID or ISSN in the Serials
359 Batch Receive interface.
364 * Adds some padding to the bottom of Web Client interfaces.
365 * Logins now honor all org unit timeout settings.
366 * Evergreen will now identify and handle invalid timezones.
367 * Fixes an issue where a column header in some interfaces were automatically
368 highlighted in green when retrieving the interface.
369 * The parts column in the Item Status screen now displays parts data.
375 We would like to thank the following individuals who contributed code,
376 tests and documentation patches to the 3.0.8 point release of
411 This release contains bug fixes improving on Evergreen 3.0.6.
413 * Fixes a performance issue with the Patron Billing History screen and
414 other screens that cause Flattener.pm to re-create joins
416 * Fixes an issue that prevented patron alerts from showing to staff at
421 We would like to thank the following individuals who contributed code,
422 tests and documentation patches to the 3.0.7 point release of
434 This release is a security release that fixes cross-site scripting
435 (XSS) vulnerabilities in the Evergreen public catalog. This release
436 also includes several other bugfixes improving on Evergreen 3.0.5.
438 Security Issue: XSS Vulnerability in Public Catalog
439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440 This release fixes several cross-site scripting (XSS) vulnerabilities
441 in the public catalog. When upgrading, Evergreen administrators should
442 review whether any of the following templates have been customized
443 or overridden. If so, either the template should be replaced with the
444 stock version or the XSS fix (which entails adding the `| html` filter
445 in several places) applied to the customized version.
447 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
448 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
449 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
451 Note that exploiting the XSS vulnerabilities fixed in this release
452 would require either the ability to create maliciously-constructed
453 MARC bibliographic or holdings records or the ability to set a
454 maliciously constructed organizational unit name.
458 Evergreen 3.0.6 also includes the following changes:
460 * When using 'Selection Lists -> Edit MARC Order Record' in the web
461 staff client, now only one click is required to save the MARC
462 record rather than two.
463 * The volume/copy editor in the web staff client now better handles
464 editing multiple items that have different sets of statistical
465 category values assigned to them.
466 * The act of merging bibliographic records now updates bookbags
467 that referred to the source bibliographic record rather than
468 effectively deleting entries for that record.
469 * Additional columns were added to the Holds Pull List in the
471 * The patron registration form in the web staff client now correctly
472 manages setting user preferences.
473 * An error in a pgTAP unit test was corrected.
477 We would like to thank the following individuals who contributed code,
478 tests and documentation patches to the 3.0.6 security release of
494 This release contains bug fixes improving on Evergreen 3.0.4.
496 * The MARC Editor in the Web staff client now wraps long fields.
497 * The MARC Editor no longer allows catalogers to enter new lines
499 * Fixes an issue that prevented serials items from being deleted or
501 * The Web staff client Check In screen no longer reloads the whole
502 page multiple times each time an item is scanned.
503 * Fixes an issue that displayed the oldest -- rather than the newest
504 -- transit in the Web staff client Item Status page.
505 * Fixes an issue that prevented the reports module from being displayed
507 * Fixes an issue in the Web staff client reports module that caused
508 syntax errors in reports that use virtual fields and joins.
509 * Fixes an issue that prevented several dropdown menus in the Web staff
510 client from activating.
511 * Fixes an issue that created duplicate copy data when copies or
512 volumes with parts were transferred.
513 * Fixes the Trim List feature in the Web staff client Check In screen.
514 * The Item Status grid now displays the Circulation Modifier.
515 * Restores missing data from the Profile column in Place Hold patron
517 * Fixes an issue with the http -> https redirect on Apache 2.4.
518 * Fixes an color contrast accessibility issue in the Web staff
519 client and adds underlining to links in grid cells for added accessibility.
520 * Adds automated regression and unit tests for the Web staff client
522 * Adds a process for spell-checking the official documentation.
523 * Adds a script that simplifies the release process related to translations.
528 We would like to thank the following individuals who contributed code,
529 tests and documentation patches to the 3.0.5 point release of
534 * Blake Graham-Henderson
549 This release contains bug fixes improving on Evergreen 3.0.3:
551 * Fixes a bug that caused all searches limited by shelving location to
553 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
554 rather than the ordering agency's SAN.
555 * Fixes a bug that prevented Safari/iOS users from logging in to the
557 * Fixes a bug that prevented users from using the browse interface.
558 * Fixes a bug in the Item Status List view that caused incorrect due
560 * Approval code is now a required field in the web client's patron
561 credit card payment form.
562 * Fixes a bug with credit card payments that caused a receipt to print
563 showing that the patron paid the bill when the payment had not actually
565 * Fixes a bug that prevented the EDI translator from being installed on
567 * Fixes a bug that caused entries to show up multiple times in the
568 Items Out and Holds tabs in the patron record.
569 * Fixes a bug that caused grids on Bills and Patron Messages
570 screens to not display properly.
571 * The following fields are now available for the Checkout and Items Out
578 ** money_summary.balance_owed
579 ** money_summary.total_paid
580 ** money_summary.total_owed
585 * The following fields are now available on the Bill Payment receipt templates:
595 * Payment type is now a column in the payments tab of the patron record
596 Bill History section.
597 * The "Replace Barcode" function now makes it more difficult for staff
598 members to attempt to create blank patron barcodes.
599 * The patron bills screen now prevents staff members from double-clicking
600 on the Apply Payment button (which otherwise would apply two payments).
601 * Fixes a bug that prevented patrons attached to statistical categories
602 from displaying in the patron search-to-hold dialog.
603 * Fixes a performance issue related to uploading CSV files of barcodes
604 to the item status and patron bucket interfaces.
605 * Fixes several small bugs in the Spanish translation.
606 * Fixes a performance bug related to patrons logging in by barcode.
610 We would like to thank the following individuals who contributed code,
611 tests and documentation patches to the 3.0.4 point release of
633 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
634 update the visibility attributes of all bibs that make use of Located URIs or
635 bib sources. It may take a while to run on large datasets. If it it running
636 too long, it can be canceled and the following psql commands will create and
637 run a script that will perform the same action serially over time without
638 blocking writes to bibs:
641 \o /tmp/luri_visibility_update.sql
642 SELECT 'UPDATE biblio.record_entry SET ' ||
643 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
644 'WHERE id = ' || id || '; SELECT ' || id || ';'
645 FROM biblio.record_entry
647 SELECT DISTINCT cn.record
648 FROM asset.call_number cn
650 AND cn.label = '##URI##'
653 FROM asset.uri_call_number_map m
654 WHERE m.call_number = cn.id
657 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
662 \i /tmp/luri_visibility_update.sql
665 It will output the id of each updated bib so that the script can be killed
666 and then edited to remove completed bibs. The remainder can be run at a
669 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
670 we do NOT update the bib's visibility attributes, as doing so causes a loop
671 and an eventual trigger stack violation. This flag should ONLY be used when
672 forcing reingest of record attributes (NOT visibility attributes), search,
673 facet, and display fields, so if using this flag under normal operation,
674 proceed at your own risk and know that Located URI and bib source changes
675 will not be reflected in the visibility attributes of the record.
679 This release contains several bug fixes improving on Evergreen 3.0.1:
681 * Fixes several issues related to the display of located URIs and records with
682 bib sources in search results.
683 * Setting `opac_visible` to false for a copy location group now hides only
684 the location group itself, rather than also hiding every single copy in the
686 * Fixes a bug that prevented the copy editor from displaying the _fine level_
687 and _loan duration_ fields.
688 * The "Edit Items" grid action in the Item Status interface will now open
689 in the combined volume/copy editor in batch. This makes the behavior
690 consistent with the "Edit Selected Items" grid action in the copy
692 * Staff members are now required to choose a billing type when creating a
693 bill on a user account.
694 * The Web client now provides staff users with an alert and option to
695 override when an item with the Lost and Paid status is checked in.
696 * Fixes a bug where the Web client offline circ interface was not able
697 to set its working location.
698 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
700 * The MARC editor in the Web staff client now presents bib sources in
702 * Both circulation and grocery bills are now printed when a staff user selects
703 a patron account and clicks "Print Bills".
704 * Fixes an issue in the XUL serials interface the "Receive move/selected"
705 action from succeeding.
706 * Fixes a typo in the user password testing interface.
710 We would like to thank the following individuals who contributed code,
711 tests and documentation patches to the 3.0.3 point release of
730 This release contains several bug fixes improving on Evergreen 3.0.1:
732 * Copy templates created in XUL Holdings Maintenance will now be
733 automatically converted and displayed in the web staff client's
735 * The list of report templates now includes a column indicating whether
736 the template was originally created in the XUL staff client or the web
737 staff client; staff need to know this since report templates created in
738 one interface cannot be edited in the other.
739 * Call number prefixes and suffixes are now displayed in various grids
740 in the web staff client, including
741 ** Pending Copy Buckets
743 ** Checkin/Capture Holds
745 ** Patron Bills History
752 ** Bib Record View Holds
754 * Many patron fields have been redacted from the web staff client's patron
755 and record holds grids, leaving patron name, username, and ID.
756 * Fixes two bugs where patron records could fail to be saved upon editing.
757 * The web staff patron editor now better warns staff users about
758 duplicate names, IDs, phone numbers, and email addresses.
759 * Human readable labels are now displayed for certain fields in standing
761 * The patron summary in the web staff client now correctly displays
762 primary and secondary ID values.
763 * The web staff client's billing full details page now displays
764 information about the staff user that created a payment.
765 * The web staff client now requires staff users to explicitly set a
766 billing type when adding a manual bill.
767 * The web staff client's patron bill annotation modal now works.
768 * Patron barcode search completion in the web staff client now allows
769 the user to select from all of the matching patron records.
770 * The Hold Shelf Slip print template in the web staff client now has
771 access to the call number.
772 * The Checkout Receipt print template in the web staff client now can
773 include summary financial information, incuding current balance, total
774 paid on outstanding fines, and total owed.
775 * The web staff print templates for current and historical bills can
776 now include copy barcode and title.
777 * Fixes a bug that resulted in some catalog searches unexpectedly
779 * Fixes a bug that resulted in catalog searches that specify a location
780 limit returning incorrect results.
781 * Fixes a bug where deleted copies could make records visible in the
783 * Fixes a bug where certain queries on copies used in the public catalog
785 * Fixes a bug place a hold request in the public catalog could result
786 in "forgetting" the type and library of the user's previous search.
787 * The web staff client now respects staff user session timeouts, and
788 will log out all open tabs if a user's session has timed out.
789 * The web staff Z39.50 page will now give the staff user an alert if
790 they attempt to import a record with a duplicate TCN.
791 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
792 entries from being deleted.
793 * Fixes a bug that made using the volume/copy editor to change a copy's
795 * The administration interface for hard due dates now ensures that
796 new (or edited) ceiling dates have their time component set to end
797 of day, resolving an issue where ceiling dates would not be applied
798 during the ceiling date itself.
799 * The web staff client can now include dynamic information in browser
800 tab titles, e.g., "Smith, Jane - Checkout".
801 * The Concerto sample data set now includes data allowing for testing
802 placing holds on monographic parts.
803 * Asset merging during bibliographic record merging now correctly
804 recognizes call number prefixes and suffixes and deletes disused
806 * Fixes a bug where displaying user surveys could result in PCRUD
808 * Fixes a bug where pg_restore of an Evergreen database could fail
809 to create certain indexes on the `actor.usr` table.
813 We would like to thank the following individuals who contributed code,
814 tests and documentation patches to the 3.0.2 point release of
845 This release contains several bug fixes improving on Evergreen 3.0.0
847 * Fixes a bug in the web staff client that prevented initials from being
848 stored with copy notes.
849 * Adds billing types that may have been missed by systems that were
850 running Evergreen prior to the 1.4 release.
851 * Fixes a web staff client bug with the CSV export option available from
852 the Import Queue in the MARC Batch Import/Export interface.
853 * Adds the missing copy alert field in the web client's volume/copy
855 * Fixes a bug where the setting to require date of birth in patron
856 registration was not being honored in the web staff client.
857 * Fixes a bug in the web staff client patron registration form where the
858 password wasn't generating from the last four digits of the patron's
860 * Fixes an issue in the web staff client where the complete barcode did
861 not display in some interfaces when partial barcodes were scanned.
862 * Fixes an HTML error in the new copy tags that display on the record
864 * Fixes a web staff client bug where recording a large number of in-house
865 uses at one time doesn't display a confirmation dialog once it hits the
867 * Adds a _Print Full Grid_ action in the web staff client
868 holds pull list to allow staff to print the entire pull list as it
869 displays on the screen. This change also changes the _Export CSV_ action
870 to an _Export Full CSV_ option.
871 * Fixes an issue with the Patron Messages interface that prevented it
872 from saving column configuration changes in the web staff client.
873 * Fixes a bug in the web staff client where a billing prompt did not
874 correctly display after marking an item damaged in those systems that
875 have enabled the setting to bill for damaged items.
876 * Adds an option to the specific due date feature that allows saving
877 that due date until logout. This allows all circulations from a given
878 workstation to be due on the same date.
882 We would like to thank the following individuals who contributed code,
883 tests and documentation patches to the 3.0.1 point release of
905 The minimum version of PostgreSQL required to run Evergreen 3.0 is
906 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
908 Change to Names of Shared Libraries
909 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
910 OpenSRF 3.0 changes how the shared libraries for services written in
911 C are named. If upgrading from an earlier version of Evergreen,
912 `opensrf.xml` should be edited so that shared library file names
913 listed in the `<implementation>` tag start with "lib". For example,
916 ---------------------------------------------------------------------
918 <language>C</language>
919 <implementation>oils_cstore.so</implementation>
920 ---------------------------------------------------------------------
922 should be changed to:
925 ---------------------------------------------------------------------
927 <language>C</language>
928 <implementation>liboils_cstore.so</implementation>
929 ---------------------------------------------------------------------
931 SIP Bugfix Requires SIPServer Upgrade
932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
934 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
935 crash" requires that you also upgrade SIPServer with the fix for
936 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
937 SIP client problems." This means that if you use SIP2 with Evergreen,
938 you must also upgrade SIPServer to the latest commit in the Git
939 repository. Conversely, if you upgrade SIPServer to the latest commit
940 in Git, you must also upgrade Evergreen or, at least, apply the patch
941 for Launchpad Bug 1542495. These two patches are complementary and
942 cannot be applied independently of one another.
944 `open-ils.auth.login`
945 ~~~~~~~~~~~~~~~~~~~~~
946 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
947 API's in the `opensrf_core.xml` file.
952 ---------------------------------------------------------------------
953 --- a/Open-ILS/examples/opensrf_core.xml.example
954 +++ b/Open-ILS/examples/opensrf_core.xml.example
955 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
957 <match_string>open-ils.auth.authenticate.verify</match_string>
958 <match_string>open-ils.auth.authenticate.complete</match_string>
959 + <match_string>open-ils.auth.login</match_string>
960 <match_string>open-ils.auth_proxy.login</match_string>
961 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
962 <match_string>open-ils.actor.user.password</match_string>
963 ---------------------------------------------------------------------
967 Administrators of Evergreen who use RTL locales and who have customized
968 `style-rtl.css.tt2` should now incorporate their customizations into
971 Multi-Time Zone Installations
972 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
974 For Evergreen consortia that span more than one time zone, the following
975 query will adjust all historical, unaged circulations so
976 that if their due date field is pushed to the end of the day, it is done
977 in the circulating library's time zone, and not the server time zone.
979 It is safe to run this after any change to library time zones.
981 Running this is not required, as no code before this change has
982 depended on the time string of '23:59:59'. It is also not necessary
983 if all of your libraries are in the same time zone, and that time zone
984 is the same as the database's configured time zone.
993 for ou_id in select id from actor.org_unit loop
994 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
995 if new_tz is not null then
996 update action.circulation
997 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
998 where circ_lib = ou_id
999 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
1008 Deprecation of XUL staff client
1009 -------------------------------
1010 Starting with the release of 3.0.0, patches that fix XUL bugs will not
1011 be merged into master or backported unless they meet one or more of
1012 the following conditions:
1014 a. the bug is a security issue
1015 b. the bug involves the destruction of data
1016 c. the bug is a regression of functionality in the XUL staff client
1017 introduced by other work done to Evergreen
1019 Under no circumstances will XUL staff client feature enhancements be merged.
1021 This policy will continue through the 3.0.x and 3.1.x maintenance
1022 release cycles, and will become moot upon the release of 3.2.0, when
1023 the XUL staff client is slated to be entirely removed.
1032 Evergreen 3.0 features a new, modern staff client that runs in the web browser
1033 and can be used on desktop and mobile devices. All functional areas of the
1034 system, including circulation, cataloging, acquisitions, serials, reports,
1035 booking, administration, and offline circulation, are available in the new staff
1036 client. Chrome and Firefox are officially supported for use with the web client.
1038 Library staff will no longer need to download separate software to perform most
1039 actions in Evergreen. A Chrome plugin called Hatch will be available as a
1040 separate installation for workstations that require seamless, dialog-free
1041 printing to multiple printers.
1043 In addition to adding more portability and stability, the new staff client also
1044 presents a cleaner and more modern interface for users. By virtue of running in
1045 a browser, actions that users are accustomed to performing on other web sites
1046 should now be available in the Evergreen client.
1048 The old, XUL client will continue to be available to allow for a gradual
1049 transition to the browser-based client, but no new features will be added. The
1050 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1060 New EDI Order Generator
1061 ^^^^^^^^^^^^^^^^^^^^^^^
1066 . New database tables exist for configuring vendor-specific EDI order
1070 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1072 * `acq.edi_attr_set`
1073 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1075 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1076 the stock configuration found in the JEDI template.
1077 * `acq.edi_attr_set_map`
1078 ** Link between `edi_attr`s and `edi_attr_set`s.
1080 . EDI Attribute Sets are manged via a new (browser client only) configuration
1081 interface at 'Administration -> Acquisitions Administration -> EDI
1084 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1085 is not set, default values will be used. Links between an EDI account
1086 and an attribute set are managed in the EDI Accounts configuration
1089 . Local modifications to the stock EG JEDI template are managed by modifying
1090 and/or adding additional `edi_att_set`s as needed.
1092 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1093 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1095 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1096 definition is no longer required and can be disabled.
1101 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1102 specifies whether PO's generated via the account should be built using
1103 EDI attributes or fall back to traditional JEDI A/T template generation.
1105 This allows sites to activate EDI attributes on a per-account basis, making
1106 it possible to migrate piecemeal to EDI attributes. For the initial roll
1107 out of this new feature, no accounts will be configured to use EDI
1108 attributes by default.
1114 3 Day Courtesy Notice by SMS
1115 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1116 New optional SMS text notification to be sent out 3 days prior to the due
1117 date of any circulating item for patrons who have an SMS text number and
1118 carrier stored in their accounts. This action trigger is disabled by default,
1119 but can be enabled and modified by going into 'Administration -> Local Administration ->
1120 Notifications / Action Triggers'.
1122 You may wish to make use of granularity so that these messages are batched
1123 and sent at the same time each day.
1128 Add Description Field to Circulation and Hold Configuration Entries
1129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1130 The circulation and hold policy configuration rules now each have a
1131 description field. This allows administrators to add comments to
1132 describe the purpose of each rule.
1137 Apache Internal Port Configuration Option
1138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1139 Apache configuration now supports a new variable which allows admins to
1140 specify the port used by Apache to handle HTTP traffic. The value is
1141 used for HTTP requests routed from Perl handlers back to the same Apache
1142 instance, like added content requests. Use this when running Apache
1143 with a non-standard port, typical with a proxy setup. Defaults to "80".
1146 -------------------------------------------------------------------
1149 PerlSetVar OILSWebInternalHTTPPort "7080"
1152 -------------------------------------------------------------------
1157 Configurable Bib Record Display Fields
1158 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1160 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1161 fields: 'Display Field?' and 'Display XPath'.
1163 When 'Display Field' is set to true, data from the field will be extracted
1164 from each record and added to a new table of display data for each bib
1167 If a value is present in the 'Display XPath' field, this XPath will be
1168 applied to the extracted data *after* the base XPath (from the 'XPath'
1169 field) is applied to each field.
1171 This data acts as a replacement for the various and sundry ways bib record
1172 data is currently extracted, including inline XPath in the TPAC, reporter
1173 views, real-time 'MVR' compilation from MODS, etc. and will be available
1174 to the user interface, notification templates, etc. for rendering bib
1177 The browser client gets a new service 'egBibDisplay' which is capable
1178 of translating the display field data from various formats into
1179 data more suitable for JavaScript usage.
1181 The database gets 3 new views for representing display data in various
1184 * `metabib.flat_display_entry`
1185 ** List of all display fields linked to their configuration.
1186 * `metabib.compressed_display_entry`
1187 ** Same as `metabib.flat_display_entry` except there's one row
1188 per display field type, with 'multi' rows compressed into
1189 JSON arrays. Non-multi fields are represented as JSON
1191 * `metabib.wide_display_entry`
1192 ** Tabular view of display field data, one column per well-known
1193 field. Values are represented JSON, consistent with
1194 `metabib.flat_display_entry`. The view does *not* contain locally
1195 configured display fields, as each field must be encoded in
1196 the view and IDL definition. This is essentially a replacement
1197 for `reporter.simple_record`.
1202 After making changes to display field configuration, it's possible to
1203 reingest only display field data in the database using the following:
1206 ---------------------------------------------------------------------
1207 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1208 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1209 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1210 ---------------------------------------------------------------------
1216 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1217 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1218 The existing permission was incorrectly created with a code of
1219 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1220 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1221 update changes the permission code to match what the event requires.
1227 Hold Targeter V2 Repairs and Improvements
1228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1229 * Make the batch targeter more resilient to a single-hold failure.
1230 * Additional batch targeter info logging.
1231 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1232 * Removes the confusingly named `--target-all` option
1233 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1234 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1236 New --next-check-interval Option
1237 ++++++++++++++++++++++++++++++++
1238 Specify how long after the current run time the targeter will retarget
1239 the currently affected holds. Applying a specific interval is useful
1240 when the retarget-interval is shorter than the time between targeter
1243 For example, if the targeter is run nightly at midnight with a
1244 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1245 since the holds won't be processed again until 48 hours later. This
1246 ensures that the org unit closed date checks are looking at the correct
1249 This setting overrides the default behavior of calculating the next
1250 retarget time from the retarget-interval.
1252 New --soft-retarget-interval Option
1253 +++++++++++++++++++++++++++++++++++
1254 This is a replacement for (and rebranding of) the `--skip-viable` option.
1255 The new option allows for time-based soft-targeting instead simple binary
1256 on/off soft-targeting.
1258 How soft-targeting works:
1260 * Update hold copy maps for all affected holds
1261 * Holds with viable targets (on the pull list) are otherwise left alone.
1262 * Holds without viable targets are retargeted in the usual manner.
1268 New marc_export --descendants Option
1269 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1271 The `marc_export` script has a new option, `--descendants`. This option
1272 takes one argument of an organizational unit shortname. It works much
1273 like the existing `--library` option except that it is aware of the
1274 org. tree and will export records with holdings at the specified
1275 organizational unit and all of its descendants. This is handy if you
1276 want to export the records for all of the branches of a system. You
1277 can do that by specifying this option and the system's shortname,
1278 instead of specifying multiple `--library` options for each branch.
1280 The `--descendants` option can be repeated, as the `--library` option can.
1281 All of the specified org. units and their descendants will be included
1282 in the output. It can also be combined with individual `--library`
1283 options when necessary.
1288 RTL and LTR Public Catalog Stylesheets Merged
1289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1290 The RTL stylesheet for the public catalog,
1291 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1292 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1293 template will provide RTL or LTR styles based on the value of
1294 the `rtl` flag of the active locale. An `rtl` variable is also available
1295 in the template to allow the correct style to be chosen.
1300 Miscellaneous Improvements
1301 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1303 * If a filter is in effect in the Library Settings Editor,
1304 the filter will continue to be applied after a user
1305 changes the selected library.
1306 * Copy templates used for serials now correctly link to age
1307 protection rules and MARC item type values (for the
1308 "Circ as Type" field). During upgrade, the database update
1309 will set to NULL any age protection and circ as type fields
1310 in serial copy templates that do not point to defined values.
1315 Obsolete Internal Flag Removed
1316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1318 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1319 flag was removed from the `config.internal_flags` table. It was
1320 rendered obsolete by the addition of the 3 flags to control the
1321 browse, search, and facet indexing.
1326 Tweaks to Caching/Expiry of Public Catalog Assets
1327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1328 The default cache expiration time for static assets (e.g.,
1329 CSS, image, and JavaScript files) in the public catalog and
1330 the Kid's PAC has been increased to one year. Links to all
1331 such assets now have a cache-busting value tacked on as a
1332 query parameter. This value is refreshed when `autogen.sh` is
1333 run, but it can also be manually set by adjusting the
1334 `ctx.cache_key` Template Toolkit variable.
1339 Action/Trigger Events Data Purging
1340 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1342 Action/Trigger event definitions have a new field called 'Retention
1343 Interval'. When an optional interval value is applied, events and
1344 template output data linked to the event definition will be deleted
1345 from the database once they reach the specified age.
1347 Retention Interval Restrictions for Passive Hooks
1348 +++++++++++++++++++++++++++++++++++++++++++++++++
1350 Restrictions are placed on retention interval values for event definitions
1351 using passive hooks to prevent data from being deleted while it's still
1352 needed by the system.
1354 The presence of event data is how the system knows not to send duplicate
1355 events. As long as a scenario exists where a duplicate event may be
1356 generated, the events must be retained.
1358 To apply a retention interval value to a passive-hook event definition:
1360 * The event definition must have a max_delay value.
1361 * The retention interval must be larger than the difference between
1362 the `delay` and `max_delay` values.
1364 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1365 interval must be greater than 3 days to ensure no duplicate events are
1366 created between the first event on day 7 and the end of the event validity
1372 A new `purge_at_events.sh` script is installed in the bin directory
1373 (typically `/openils/bin`) which should be added to CRON for regular
1376 NOTE: On large data sets, this script can take a long time to run and
1377 create higher than normal I/O load as it churns though the event and
1378 event_output tables. You may wish to run the script by hand the first
1379 time so it can be monitored. It can be run in psql like so:
1382 ---------------------------------------------------------------
1383 SELECT action_trigger.purge_events();
1384 ---------------------------------------------------------------
1386 NOTE: On *very* large data sets (10s to 100s of millions of event and
1387 event_output rows), it may be advisable to first repopulate the `event`
1388 and `event_output` tables with only the desired data before starting
1389 regular purges. This can be done, for example, using the copy to temp
1390 table, truncate source table, repopulate source table from temp table
1391 approach. This will be much faster than the `purge_events()` function
1392 in cases where most of the data will be purged.
1397 A number of `action_trigger.hook` entries which have always been treated
1398 as active hooks, though are configured as passive hooks, have been
1399 updated to properly reflect the non-passive-ness. This allows for
1400 simpler configuration of their retention interval values.
1406 Remove JSPAC Redirects
1407 ^^^^^^^^^^^^^^^^^^^^^^
1408 Future versions of Evergreen will no longer contain automatic redirects
1409 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1410 that the JSPAC is no longer supported. Existing sites, however, may
1411 wish to retain JSPAC redirects in their Apache configuration files since
1412 JSPAC URLs may still be used in the wild to access their catalogs.
1414 The original JSPAC URL redirects are all retained in the file
1415 `Open-ILS/examples/jspac_redirects.conf` for reference.
1425 New open-ils.auth.login API
1426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1427 The `open-ils.auth` service has a new API for requesting an authentication
1428 token. It performs the same steps as the
1429 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1430 using the bare password. No intermediate password hashing is required.
1432 The paramaters are the same as the `.complete` call with a few modifications.
1434 1. Using the generic 'identifier' parameter in combination with the
1435 'org' parameter allows the API to reliably determine if an identifier
1436 value is a username or barcode. The caller is no longer required to
1437 make that determination up front.
1439 2. The 'nonce' parameter is no longer used.
1445 Batch Patron Contact Invalidation
1446 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1447 The following methods are used to mark patron contact fields
1448 as invalid by moving the invalid value to a standing penalty:
1450 * `open-ils.actor.invalidate.email`
1451 * `open-ils.actor.invalidate.day_phone`
1452 * `open-ils.actor.invalidate.evening_phone`
1453 * `open-ils.actor.invalidate.other_phone`
1455 These methods now accept a fifth argument specifying the value
1456 of the contact field, e.g., a specific phone number or email
1457 address. If supplied, and if a specific patron ID (the first
1458 argument) is not supplied, all patrons with that specific contact
1459 value will have it marked invalid.
1469 Pure-SQL catalog searching
1470 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1471 Public and staff catalog search is now both more accurate and faster
1472 by redesigning how the visibility of records is calculated.
1482 Authority Record and Headings Browse Improvements
1483 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1484 Various improvements are made to support for authority records
1485 and headings browsing:
1487 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1488 headings from authority records. Since the MODS and MADS stylesheets
1489 extract headings in similar ways, duplicate browse entries are now
1490 much less likely to occur.
1491 * A new configuration table, `authority.heading_field`, is now used
1492 to specify how headings should be extracted from authority records.
1493 * Related headings can now be identified as narrower or broader when
1494 browsing in the public catalog.
1495 * See references are now more reliably included in the browse list.
1496 * Scope (public) notes now display only under the main heading.
1497 * There is now a global flag, Display related headings (see-also) in browse,
1498 that can be used to control whether related headings (see-alsos) are
1499 displayed in the public catalog list.
1500 * A complete set of thesauruses are now included in the seed data. Thesauruses
1501 can now be identified using short and long codes.
1502 * The labels for see and see-also references in the public catalog are
1503 a bit more patron-friendly, and can now be tweaked via TPAC template
1504 customization in the browse.tt2 file.
1510 Copy Tags and Digital Bookplates
1511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1512 Copy tags will allow staff to apply custom, pre-defined labels or tags
1513 to copies. Copy tags are searchable in both the staff client and public
1514 catalog. This feature was designed to be used for Digital Bookplates to
1515 attach donation or memorial information to copies, but may be used for
1516 broader purposes to tag items.
1518 Each copy tag can either be publicly-visible or visible only to staff.
1519 Copy tags also have types that can be used for restricting catalog
1520 searches on copy tags to particular types.
1522 Copy tags are displayed in the copy table in the record summary page in
1523 the public catalog, and a new library setting can be used to add
1524 a "Digital Bookplate" search field. Copy tags can also be used
1525 as a search filter, e.g.,
1527 * `copy_tag(bookplate, jane smith)`: search for records that have a
1528 copy tag of type 'bookplate' whose value contains 'jane smith'.
1529 * `copy_tag(*, jane smith)`: search for records that have a
1530 copy tag of any type whose value contains 'jane smith'.
1532 All staff-side interfaces related to copy tags exist only in the web
1533 staff client. There are two new administration interfaces for managing
1534 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1535 button for applying copy tags to copies; that interface can also be
1536 used to create new copy tags on the fly. Furthermore, the copy buckets
1537 interface now has an 'Apply Tags' action for assigning tags to groups
1543 Two new permission are included:
1545 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1546 'Administration -> Server Administration -> Copy Tag Types'
1547 * `ADMIN_COPY_TAG`: required to create a new tag under
1548 'Administration -> Local Administration -> Copy Tags'
1550 The existing permission `UPDATE_COPY` controls whether or not a user
1551 can link copies to tags.
1555 A new library setting, 'Enable Digital Bookplate Search', controls
1556 whether to display a 'Digital Bookplate' field in the search index
1557 drop-downs in the catalog. A 'Digital Bookplate' search will include
1558 all records that have a copy that matches the tag specified by the user.
1559 It should be noted that this library setting does not affect the
1560 display of copy tags on the catalog record summary page.
1565 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1566 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1567 The call number prefix and suffix, when present, are now included in
1568 subfields $k and $m of the 852 field when running `marc_export` with
1569 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1570 server configured to embed item data in 852 fields, the affixes are now
1571 included in subfields $k and $m.
1581 Batch Editing of Patron Records
1582 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1583 There is a now a new interface analogous to the Copy Bucket interface
1584 to select and group a set of users into a User Bucket.
1585 The addition of users to a User Bucket is possible from the Patron Search
1586 interface by the use of a new grid Action, and directly on the User Bucket
1587 interface by user barcode. It is also possible to add users to a User
1588 Bucket by uploading a text file that contains a list of user barcodes.
1590 From this interface it is possible to perform a set of specific batch update
1591 operations on user records.
1596 These fields can now be changed in batch via an action on the User Bucket
1597 grid if the staff user has the `UPDATE_USER` permission:
1600 * Primary Permission Group (group application permissions consulted)
1602 * Home Library (`UPDATE_USER` checked against both old and new value)
1603 * Privilege Expiration Date
1604 * Barred flag (`BAR_PATRON` permission consulted)
1605 * Internet Access Level
1607 Changes made in this interface can be rolled back.
1609 As a batch process, rather than a direct edit, this mechanism explicitly skips
1610 processing of Action/Trigger event definitions for user update.
1615 The batch edit mechanism also allows for the batch deletion of user. The staff
1616 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1618 Changes made in this interface can be rolled back.
1620 As a batch process, rather than a direct edit, this mechanism explicitly skips
1621 processing of Action/Trigger event definitions for user deletion.
1623 This mechanism does not use the Purge User functionality, but instead simply
1624 marks the users as deleted.
1626 Editing Statistical Category Entries
1627 ++++++++++++++++++++++++++++++++++++
1629 All users in the bucket can have their Statistical Category Entries
1630 modified. Unlike user data field updates, modification of Statistical
1631 Category Entries is permanent and cannot be rolled back.
1633 As a batch process, rather than a direct edit, this mechanism explicitly skips
1634 processing of Action/Trigger event definitions for user update.
1636 New Service Requirement
1637 +++++++++++++++++++++++
1639 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1640 unused in production. If this service has been removed from the configuration
1641 of a live Evergreen instances, it will need to be added back in order for
1642 batch user editing to succeed.
1647 Honor Timezone of the Acting Library
1648 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1653 * Display day-granular due dates in the circulating library's timezone.
1654 * Only display the date portion of the due date for day-granular circulations.
1655 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1656 * Provide infrastructure for more advanced formatting of timestamps.
1657 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1662 This is a followup to the work done for 2.12, where we added the ability
1663 for the client to specify a timezone in which timestamps should be interpreted
1664 in business logic and the database.
1666 Most specifically, this work focuses on circulation due dates and the closed
1667 date editor. Due dates, where displayed using stock templates (including
1668 receipt templates) and used for fine calculation, are now manipulated in the
1669 library's configured timezone. This is controlled by the new 'lib.timezone'
1670 setting available via the Library Settings Editor, loaded from the server when
1671 required. Additionally, closings are recorded in the library's timezone so that
1672 due date calculation is more accurate. The closed date editor is also
1673 taught how to display closings in the
1674 closed library's timezone. Closed date entries also explicitly record if they
1675 are a full day closing, or a multi-day closing. This significantly simplifies
1676 the editor, and may be useful in other contexts.
1678 To accomplish this, we use the moment.js library and the moment-timezone addon.
1679 This is necessary because the stock AngularJS date filter does not understand
1680 locale-aware timezone values, which are required to support DST. A simple
1681 mapper translates the differences in format values from AngularJS date to
1684 Of special note are a set of new filters used for formatting timestamps under
1685 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1686 filters provide the functionality, and autogrid is enhanced to make use of
1687 these where applicable. egGrid and egGridField are also taught to accept
1688 default and field-specific options for applying date filters. These filters may
1689 be useful in other or related contexts.
1691 The egDueDate filter, used for all existing displays of due date via Angular
1692 code, intentionally interprets timestamps in two different ways WRT timezone,
1693 based on the circulation duration. If the duration is day-granular (that is,
1694 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1695 of seconds) then the date is interpreted as being in the circulation library's
1696 timezone. If it is an hourly loan (any duration that does not meet the
1697 day-granular criterium) then it is instead displayed in the client's timezone,
1698 just as all other timestamps currently are, because of the previous Evergreen
1701 The public catalog is adjusted to always display the due date in the circulating
1702 library's timezone. Because the public catalog displays only the date portion of the due
1703 date field, this difference is currently considered acceptable. If this proves
1704 to be a problem in the future, a minor adjustment can be made to match the
1705 egDueDate filter logic.
1707 Now that due dates are globally stored in the configured timezone of the
1708 circulating library, the automatic adjustment to day-granular due dates needs
1709 to take those timezones into account.
1711 An optional SQL command is provided by the upgrade script to retroactively
1712 adjust existing due dates after library configuration is complete.
1718 Enhancements to Hard Due Date Functionality
1719 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1720 It will now be possible to delete Hard Due Date Values for dates that have
1721 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1722 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1723 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1728 Patron Search by Birth Date
1729 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1730 * Now you can include the patron birth year and/or birth month and/or
1731 birth day when searching for patrons using the web staff client.
1732 * Day and month values are exact matches. E.g. month "1" (or "01")
1733 matches January, "12" matches December.
1734 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1735 1915, 1599, etc. For exact matches use the full 4-digit year.
1739 Patron Search from Place Hold
1740 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1741 This feature allows staff members, when placing a
1742 hold on behalf of a patron in the web staff client, to search for
1743 patrons by names and other searchable patron information, rather than
1744 relying on barcode alone. In particular, after performing a catalog
1745 search or going to a specific bib record and clicking the 'Place Hold'
1746 button, the form now includes a 'Patron Search' button. This button
1747 will open a dialog allowing the staff member search for and select
1753 Retrieve Recent Patrons
1754 ^^^^^^^^^^^^^^^^^^^^^^^
1756 Adds a new library setting 'Number of Retrievable Recent Patrons'
1757 ('ui.staff.max_recent_patrons') that specifies the number of recently
1758 retrieved patrons that can be re-fetched from the staff client.
1760 A value of 0 means no recent patrons can be retrieved.
1761 A value greater than 1 means staff will be able to retrieve multiple
1762 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1764 The default value is 1 for backwards compatibility.
1771 Fuller title in XUL client Simplified Pull List
1772 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1773 The Simplified Pull List in the XUL client will now display subfields 245$n and
1774 $p in the title field. The addition will make it easier for staff to distinguish
1775 between different parts or seasons in a series.
1781 Transit Cancel Time and Terminology Change
1782 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1787 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1788 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1789 are preserved in the database, though still not visible to the end user in the staff client.
1790 This allows for better tracking of when transits are canceled for the purposes of knowing
1791 which staff member canceled the transit, etc.
1793 NOTE: This change may require the re-creation of transit reports to filter out canceled
1794 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1795 Is NULL' will suffice.
1797 "Canceled Transit" Terminology Change
1798 +++++++++++++++++++++++++++++++++++++
1800 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1801 For internal continuity, however, the following permission codes have not changed:
1804 * `ABORT_REMOTE_TRANSIT`
1805 * `ABORT_TRANSIT_ON_LOST`
1806 * `ABORT_TRANSIT_ON_MISSING`
1814 Offline Circulation Available in Web Staff Client
1815 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1816 Offline circulation is now available in the web staff client. In order to use the
1817 offline interface, users must first log into the web staff client, perform
1818 a patron search, select a user from the results, and open the patron editor
1819 interface to collect all the relevent configuration information for the
1820 workstation. In addition, the offline interface available from the Circulation
1821 menu provides a 'Download block list' button for users who are logged in.
1823 As is the case in the old staff client, users can check materials in and out,
1824 renew items, and create new patron accounts while offline. The patron fields
1825 available in the offline patron registration editor are the same ones that
1826 are available to staff when working online.
1830 Add Circ Modifier to Record Detail Page in Staff TPAC
1831 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1832 The circulation modifier field is added to the table of copies to make
1833 more information available to staff without having to open
1840 Date+Time Format Settings for Web Client
1841 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1843 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1844 and adds two settings for use with the webstaff client:
1846 * 'Format Dates with this pattern'
1847 * 'Format Date+Time with this pattern'
1849 These settings use format strings as documented here:
1851 https://docs.angularjs.org/api/ng/filter/date
1853 There is overlap with how the Dojo formats worked, but also some differences.
1855 The original 'Format Dates' and 'Format Times' settings worked together, but the
1856 new settings work independently. Certain field elements will use one, and
1857 certain field elements will use the other. These distinctions are hard-coded
1858 in the various UI templates, with the idea being that timestamp fields in
1859 which the date component alone is sufficient information (for example, date of birth)
1860 will use the 'Format Dates' setting. Fields where the time component is
1861 important (for example, checkout time) will use the 'Format Date+Time' setting.
1863 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1864 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1870 Global Option to Remove Sound for a Specific Event
1871 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1872 A new `nosound.wav` file has been added to the web client. The file can be used
1873 to globally disable audio alerts for a specific event on an Evergreen system.
1875 For example, to silence the alert that sounds after a successful patron search:
1879 mkdir -p /openils/var/web/audio/notifications/success/patron/
1880 cd /openils/var/web/audio/notifications/success/patron/
1881 ln -s ../../nosound.wav by_search.wav
1888 The official Evergreen manual has been split into eight new manuals, each
1889 designed for a specific audience. This new approach is designed to make
1890 the documentation more readable and usable.
1892 The specific audiences for the new manuals are:
1894 * Acquisitions staff
1897 * Public services staff who use the public catalog
1899 * System administrators who use the command line
1900 * System administrators who use the Web client
1901 * System administrators and programmers who wish to integrate Evergreen
1902 with other technologies
1904 All manuals are available at http://docs.evergreen-ils.org
1910 Improvements to ebook API
1911 ^^^^^^^^^^^^^^^^^^^^^^^^^
1913 Evergreen now supports checking out and placing holds on
1914 OverDrive and OneClickdigital ebook titles from within the public
1915 catalog. This is an experimental feature. It is not recommended for production
1916 use without careful testing.
1918 When ebook integration is enabled, a "Check Out E-Item" link will be
1919 displayed when viewing an ebook title from a supported vendor in the
1920 catalog. Clicking on the link allows the user to check out and download
1921 that title from the vendor directly within the catalog.
1923 If no copies are available for the title, a "Place Hold on E-Item" link
1924 is displayed instead, and the user may place a hold on the title. (Note
1925 that some vendors require the user's account to have an email address
1926 before permitting a hold.)
1928 My Account includes the ability to view current ebook checkouts and
1929 holds, download already-checked-out titles, and cancel holds.
1931 For API integration to work, you need to request API access from the
1932 vendor, and the vendor must have a way of authenticating your patrons.
1933 Your Evergreen system also needs to be configured for ebook API
1934 integration, following the instructions in the command line system
1935 administration manual
1938 This feature assumes that you are importing MARC records supplied by the
1939 vendor into your Evergreen system, using Vandelay or some other MARC
1940 import method. This feature does not search the vendor's online
1941 collections or automatically import vendor records into your system; it
1942 merely augments records that are already in Evergreen.
1944 Improvements to Bill Payment Pages
1945 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1946 The bill payment pages in the public catalog have been revamped
1949 * use the term "charges" instead of "fees"
1950 * include images of credit cards accepted
1951 * make the default print receipt template match other itemized receipts;
1952 note that this change is not automatically applied when upgrading.
1953 * display billing type
1954 * add button to pay only selected charges
1955 * reformat the credit card number input page
1961 Clickable Copy Locations
1962 ^^^^^^^^^^^^^^^^^^^^^^^^
1963 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1964 the associated copy location will display as a link in the public catalog summary display.
1965 This link can be useful for retrieving maps or other directions to the copy
1966 location to aid users in finding material.
1971 Download Checkout History CSV Fixed for Large Number of Circulations
1972 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1973 Downloading checkout history as a CSV from My Account has been fixed
1974 for users with a large circulation history. Previously, this would
1975 time out for patrons with more than 100 or so circulations.
1977 This feature no longer uses the action/trigger mechanism and the public catalog
1978 now generates the CSV directly. The old action/trigger code is still
1979 present in the database and should be removed at some point in the
1985 Google Books Preview Rewrite
1986 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1987 The Google Books Preview functionality in record detail pages has been
1988 rewritten to modernize its style and optimize its performance:
1990 * The Dojo JavaScript framework is no longer used, saving approximately
1991 150K of JavaScript and CSS and four network requests per page load.
1992 * The Embedded Viewer is not loaded unless a possible preview is found,
1993 saving more network and memory overhead.
1994 * The Google Books Loader is used to load the Embedded Viewer instead of the
1995 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1997 * All variables are self-contained and do not pollute the global namespace.
1998 * Event listeners are registered to handle clicks, rather than attaching
1999 `href="javascript:function()"` to <a> elements.
2000 * Book previews are displayed in a panel sized according to the viewport
2001 of the browser, improving its appearance on both mobile and desktop
2003 * The rewritten code is now served up directly from
2004 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
2009 jQuery for the Public Catalog
2010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011 This release adds optional support for jQuery in the public catalog. This support
2012 is enabled by setting the `ctx.want_jquery` variable to a true value in the
2013 `config.tt2` template.
2019 New Popularity Parameters
2020 ^^^^^^^^^^^^^^^^^^^^^^^^^
2021 New popularity parameters for in-house use over time and for count of distinct
2022 organizational units that own a title are now available. Evergreen sites
2023 can use these parameters to create new statistical popularity badges for
2024 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
2026 The in-house use parameters will apply a badge to titles that have the most
2027 in-house use activity over time. The organizational unit count parameter
2028 will apply a badge to titles owned by the most number of libraries in a
2029 consortium. Ownership is determined by the copy's circulation library.
2034 Option to Suspend Holds at the Time They are Placed
2035 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2036 Users now have the option to suspend a hold at the same time they place the
2037 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
2038 who want to suspend a hold at the time it is placed. There is also an option
2039 to set the activation date at the same time. This option is also available
2040 when placing holds on a batch of titles from 'My List' and will apply to
2041 all the titles in the batch.
2052 Fix to reporter.classic_current_circ View
2053 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2054 The `reporter.classic_current_circ` view, which is part of some
2055 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
2056 has been fixed to not exclude loans for patrons who do not have a
2057 billing address set. Users of this view should rerun
2058 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2063 New Report Source Table Allowing Report of "Last" Deleted copy
2064 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2066 This source table allows you to construct a clever aggregate report template
2067 which will report bibliographic IDs where a library or a group of libraries
2068 no longer have a copy attached but *had* a copy attached. This is especially
2069 useful when a holdings sync is required with an external vendor.
2072 Instructions for creating a report template with this source:
2074 * Create a new report template using "Library Holdings Count with Deleted" as the source
2075 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2076 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2077 * 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"
2078 * Add "Bib ID" to Displayed Fields
2079 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2080 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2081 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2084 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2085 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2086 specified date range. Unfortunately the user will have to manually type the date range without the date
2087 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2088 copy and more than two deleted copies."
2093 Add Provider to Provider Note Link
2094 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2095 The Provider reporting source now includes a link to the Provider Note reporting source.
2100 Link ILS User and Working Location Reporting Sources
2101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2102 The Working Location reporting source now has labels
2103 and it is now linked to the ILS User reporting source, allowing
2104 reports to display or filter on staff working location.
2109 New Circulation Report Source "All Circulation Combined Types"
2110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2112 This report source will allow you to create a single report template for all of the following:
2115 * In-house uses of non-cataloged items
2117 * Circulations of non-cataloged items
2119 To distinguish between these different types of library use, it's important to display these columns
2120 in your report templates:
2129 Reports Template Searching
2130 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2131 A new form appears along the top of the reports interface for searching
2132 report templates. Once found, typical template actions (e.g. create new
2133 report) are available from within the results interface.
2135 Searches may be performed across selected (visible) folders or all
2136 folders visible to the logged in user.
2138 Searches are case-insensitive, any word order, with left-anchored words.
2139 All searched words must appear in at least one of the searched fields.
2144 * Searching for 'stat cat' matches:
2146 ** statistical category
2147 ** categories, statistical
2148 ** patrons (stat cat)
2149 * Searching for 'stat cat' does not match:
2151 *** both words must be present in the searched field(s)
2153 *** location contains 'cat' but it's not left-anchored.
2158 The templates, reports, and output interfaces now support paging via
2159 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2171 Web Staff Client Serials Module
2172 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2173 The serials module has been ported over to the web staff
2174 client, implementing a unified serials interface that combines
2175 ideas from both the serial control view and alternate serials
2176 control view from the old staff client.
2178 In addition to carrying over functionality that was available
2179 in the old staff client, several new features are included:
2181 * the ability to save prediction pattern codes as templates
2182 that can be shared and reused within an Evergreen database
2183 * a more streamlined interface for managing subscriptions,
2184 distributions, and streams
2185 * it is no longer necessary to create a starting issue in
2186 order to predict a run of issues; the dialog box for
2187 generating a set of predicted issues now lets you specify
2188 the starting point directly.
2189 * the ability to more directly edit MFHDs
2191 The new serials interfaces can be accessed from the record
2192 details page via a Serials drop-down button that links to
2193 a subscription management page, a quick-receive action, and
2194 a MFHD management page. There is also a new 'Serials Administration'
2195 page where prediction pattern and serial copy templates can
2206 SIP Bugfix Changes How Encoding Is Determined in Configuration
2207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2209 The combined fix for the above mentioned SIP bugs alters the way that
2210 SIPServer looks up the output encoding in the configuration file (typically
2211 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2214 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2215 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2216 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.
2217 4. If none of the above exist, then the default encoding (ASCII) is used.
2219 Number 3 is provided to ease the transition to the new code. It is
2220 the current location of the +encoding+ element in the sample
2221 configuration file and as such, where it is likely to be found in
2222 actual files. It is recommended that you alter your configuration to
2223 move this element out of the +implementation_config+ element and into
2224 its parent +institution+ element. Ideally, SIPServer should *not* look into
2225 the implementation config, and this check may be removed at some time
2233 Web Client Acknowledgments
2234 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2236 The project to develop a new browser-based web client launched four
2237 years ago at the September 2013 Evergreen developer hack-a-way when the
2238 developer community voted to move away from the XUL client and explore other
2239 platforms. The first web client preview became available in Evergreen 2.7 when
2240 circulation was available in the new platform.
2242 The browser-based client is available due to the work of many coders, testers,
2243 bug reporters, documentors, translators, project managers, spec writers, funders
2244 and other contributors over the past four years.
2246 The Evergreen project would like to acknowledge the following organizations
2247 that funded development of the Web Staff Client:
2250 * British Columbia Libraries Cooperative
2251 * Consortium of Ohio Libraries
2253 * Georgia Public Library Service
2254 * Grand Rapids Public Library
2256 * Kenton County Public Library
2257 * King County Library System
2260 * Pennsylvania Integrated Library System
2261 * Pioneer Library System
2264 The Evergreen project would also like to thank the following individuals who
2265 contributed code, translations, documentation patches, tests, bug reports,
2266 technical specifications, and project management to the Web Staff Client:
2303 * Freddy Enrique Pelayo Huapalla
2329 Evergreen 3.0 Acknowledgments
2330 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2332 The Evergreen project would like to acknowledge the following
2333 organizations that commissioned developments in this release of
2337 * British Columbia Libraries Cooperative (BC Sitka)
2339 * Georgia Public Library Service
2340 * King County Library System
2342 * Pennsylvania Integrated Library System
2343 * Pioneer Library System
2345 We would also like to thank the following individuals who contributed
2346 code, translations, documentation patches, and tests to this release of
2395 We also thank the following organizations whose employees contributed
2398 * British Columba Libraries Cooperative
2402 * Emerald Data Networks, Inc.
2403 * Equinox Open Library Initiative
2405 * Grand Rapids Public Library
2406 * Indiana State Library
2408 * King County Library System
2409 * Lake Agassiz Regional Library
2410 * Laurentian University
2411 * Linn-Benton Community College
2413 * Merrimack Valley Library Consortium
2415 * North of Boston Library Exchange
2416 * Pennsylvania Integrated Library System
2417 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2419 * Traverse Area District Library
2421 We regret any omissions. If a contributor has been inadvertently
2422 missed, please open a bug at http://bugs.launchpad.net/evergreen/