1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.10.
9 All bug fixes refer to the web staff client unless otherwise specified.
14 * Several strings are now displayed in the correct translation.
15 * Right clicking in grids results in more intuitive behavior.
16 * Usernames and barcodes containging the _%_ character no longer
17 experience problems logging in.
18 * Fixes cases in which the web client stops loading after the toolbar.
19 * Fixes problems in which using the web client in multiple tabs leads
20 to data inconsistency.
21 * The patron triggered event screen now respects the
22 `circ.staff.max_visible_event_age` library setting.
23 * Fixes an issue which caused an exception to be thrown during
24 non-cataloged item checkout.
25 * Fixes permission issues related to merging users.
26 * The bibliographic record summary now displays the call number that
27 matches the library's classification system.
28 * The copy editor now makes shelving locations visible to catalogers
29 from other libraries as needed.
30 * Once a record is overlayed in the Z39.50 screen, it is no longer
32 * Several fixes to the filters on the Holdings View screen.
33 * Several fixes to how empty volumes are created and displayed.
34 * Fixes to item and call number transfers.
35 * The Item Status "Edited By" column now displays the username of the
36 last user to edit the item, rather than their database ID.
37 * When adding new copies, the circulation library now defaults to the
38 call number's owning library.
39 * Fixes display issues with the Print Item Labels page.
40 * Fixes an issue in which the staff client and the OPAC displayed
41 different counts of available items.
45 We would like to thank the following individuals who contributed code,
46 tests and documentation patches to the 3.0.11 point release of
63 This release contains bug fixes improving on Evergreen 3.0.9. Note that
64 all bug fixes refer to the web staff client unless otherwise specified.
69 * Fixes right-click issues with the Web client grids
70 * Fixes an issue with the Default SMS Carrier in the patron edit form.
71 * Fixes an issue that allowed overdue notices to be sent to a patron
72 whose long overdue item has been paid for.
73 * Checking in precat items now displays the "Route to Cataloging" alert each
74 time the item is checked in.
75 * Fixes an issue in which the Adjust to Zero feature
76 does not close a checked-in lost circ.
77 * Deleted copies that are still checked out can now be checked in.
78 * Fixes a mislabeled column in the patron checkout grid.
79 * Fixes an error with the missing pieces functionality.
80 * Courier codes now display in the transit slip receipt preview.
81 * The Item Status grid now displays OU shortnames instead of full names
82 for the "Circulation Library" column.
83 * The Volume/Copy editor now allows users to remove a value from the Age
84 Hold Protection field.
85 * Barcode completion now works in copy buckets.
86 * The Z39.50 interface now notices when another record has been marked
88 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
90 * Fixes a performance issue for the Validate button in the MARC Editor.
91 * Fixes an incorrect close tag in the Print Item Labels toolbar.
92 * Better scoping of copy tags in search results.
93 * Electronic Resource links now open in a new tab.
94 * Fixes an issue with the fiscal year close-out operation.
95 * Improves serials item deletes.
99 We would like to thank the following individuals who contributed code,
100 tests and documentation patches to the 3.0.10 point release of
125 This release contains bug fixes improving on Evergreen 3.0.8. Note that
126 all bug fixes refer to the web staff client unless otherwise specified.
131 * Fixes specific cases in which deleted records appear in search results.
132 * Fixes a performance issue with deleting patrons.
133 * The hold shelf dialog popup now lists the patron's notification
135 * Fixes an issue that prevented editing items when a monograph part
137 * Patron information is now available for use in the bills_current
138 and bills_historical receipt templates.
139 * The browser's "This page may contain unsaved data" warning now
140 appears when users click the update
141 expire date button in a patron account and attempt to navigate away
143 * The holds tab of the patron record now includes a monograph part
145 * The barcode box in the checkout screen
146 no longer hovers above patron record tabs when
147 staff users scroll down.
148 * Fixes an issue with the date of birth in the patron edit scren.
149 * Fixes an issue with the dropdown of billing type options.
150 * The Item Status screen now includes as a floating group column.
154 We would like to thank the following individuals who contributed code,
155 tests and documentation patches to the 3.0.9 point release of
158 * BC Libraries Cooperative
164 * Blake Graham-Henderson
181 This release contains bug fixes improving on Evergreen 3.0.7. Note that
182 all bug fixes refer to the web staff client unless otherwise specified.
190 * The MARC editor now handles 008 fields better.
191 * Adds spaces between subfields when suggesting a call
192 number for a new volume.
193 * MarcXML exports from the MARC Batch Import/Export ->
194 Export Records screen now downloads the file, rather than opening
196 * The Item Status Circulation Library column now displays a
197 shortname rather than the full library name.
198 * The Item Status Remaining Renewals column now displays
200 * The Item Status now has a "Last Renewal Workstation" column
202 * Fixes the circulation counts displayed in Item Status Details.
203 * Fixes an issue where multiple copies with different values for required
204 statistical categories could not be edited and saved in batch.
205 * Add an option to remove floating in the copy editor.
206 * Fixes an issue with the floating dropdown in the copy editor.
207 * Fixes a problem in which the copy template didn't properly copy
209 * Reduces the number of API calls that the MARC Editor requires.
214 * Fixes an issue that prevented the offline patron registration
216 * Fixes an issue with searching patrons by permission group.
217 * The barcodes in the patron search are now clickable.
218 * Staff members can now manually override the patron juvenile
219 flag value, regardless of the patron's date of birth.
220 * Checkboxes on patron registration screen are now properly aligned
222 * The user permission group dropdowns in the patron registration,
223 edit, and search interfaces now have scrollbars.
224 * The date picker on the checkout screen is now hidden unless
225 circ staff activates a specific due date option.
226 * The check-in screen now includes a copy status column.
227 * The Merge Patrons interface now displays the date of birth.
228 * The user bucket screen now displays the Bucket ID.
229 * The payment button on patron bills screen is now inactive if the
230 Payment Received field is blank.
231 * The Bill History receipt now includes a Finish date and a Last
233 * When a patron summary contains an image of the patron,
234 that image tag now has a null alt attribute to remove it from
235 the flow of a screen reader.
236 * Corrects an issue that caused the transit dialog to show the
238 * Corrects an issue with printing transit lists.
239 * "Find another target" on transiting hold no longer leaves the
241 * The images now display to distinguish hold and transit slips.
242 * The Clearable Holds list printout now only shows holds that have
244 * Restores the call number prefix and suffix fields to the holds
246 * The documentation at the top of the hold shelf slip template
248 * The cursor in the in-house use screen now automatically goes
249 to the barcode field.
250 * The in-house use screen now shows a copy status column.
251 * Add support for converting change to patron credit in the patron bills
252 interface, consistent with the XUL feature.
253 * Fixes a bug that caused pickup/request library fields to be
255 * Fixes a bug in the offline org unit tree.
257 Command-line system administration
258 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
260 * The novelist entry in `eg_vhost.conf` includes two new
262 * Corrects an issue with the `--max-sleep` argument on the
263 `action_trigger_runner.pl` support script.
264 * Corrects an issue with how the `eg_pbx_allocator.pl` script
265 detects an existing lock file.
266 * The 3.0.2-3.0.3 upgrade script disables triggers before
267 recalculating bib visibility.
272 * Fixes an issue that caused records with located URIs to be
273 retrieved in Copy Location and Copy Location Group searches.
274 * Fixes an error message that appeared in the search box
275 in the public catalog while placing hold after an advanced search.
276 * Restores the display of copy information for the user's
277 preferred library in the public catalog.
278 * Fixes regression errors in the search results page.
279 * Removes redundant call numbers from the Show More Details
281 * The cast field in the catalog is now taken from the 511 field
282 when first indicator = 1, rather than the 508.
283 * Fixes a display issue caused by editing holds.
288 * Fixes an issue that prevented users from searching for
289 receivable issues using Database ID or ISSN in the Serials
290 Batch Receive interface.
295 * Adds some padding to the bottom of Web Client interfaces.
296 * Logins now honor all org unit timeout settings.
297 * Evergreen will now identify and handle invalid timezones.
298 * Fixes an issue where a column header in some interfaces were automatically
299 highlighted in green when retrieving the interface.
300 * The parts column in the Item Status screen now displays parts data.
306 We would like to thank the following individuals who contributed code,
307 tests and documentation patches to the 3.0.8 point release of
342 This release contains bug fixes improving on Evergreen 3.0.6.
344 * Fixes a performance issue with the Patron Billing History screen and
345 other screens that cause Flattener.pm to re-create joins
347 * Fixes an issue that prevented patron alerts from showing to staff at
352 We would like to thank the following individuals who contributed code,
353 tests and documentation patches to the 3.0.7 point release of
365 This release is a security release that fixes cross-site scripting
366 (XSS) vulnerabilities in the Evergreen public catalog. This release
367 also includes several other bugfixes improving on Evergreen 3.0.5.
369 Security Issue: XSS Vulnerability in Public Catalog
370 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
371 This release fixes several cross-site scripting (XSS) vulnerabilities
372 in the public catalog. When upgrading, Evergreen administrators should
373 review whether any of the following templates have been customized
374 or overridden. If so, either the template should be replaced with the
375 stock version or the XSS fix (which entails adding the `| html` filter
376 in several places) applied to the customized version.
378 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
379 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
380 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
382 Note that exploiting the XSS vulnerabilities fixed in this release
383 would require either the ability to create maliciously-constructed
384 MARC bibliographic or holdings records or the ability to set a
385 maliciously constructed organizational unit name.
389 Evergreen 3.0.6 also includes the following changes:
391 * When using 'Selection Lists -> Edit MARC Order Record' in the web
392 staff client, now only one click is required to save the MARC
393 record rather than two.
394 * The volume/copy editor in the web staff client now better handles
395 editing multiple items that have different sets of statistical
396 category values assigned to them.
397 * The act of merging bibliographic records now updates bookbags
398 that referred to the source bibliographic record rather than
399 effectively deleting entries for that record.
400 * Additional columns were added to the Holds Pull List in the
402 * The patron registration form in the web staff client now correctly
403 manages setting user preferences.
404 * An error in a pgTAP unit test was corrected.
408 We would like to thank the following individuals who contributed code,
409 tests and documentation patches to the 3.0.6 security release of
425 This release contains bug fixes improving on Evergreen 3.0.4.
427 * The MARC Editor in the Web staff client now wraps long fields.
428 * The MARC Editor no longer allows catalogers to enter new lines
430 * Fixes an issue that prevented serials items from being deleted or
432 * The Web staff client Check In screen no longer reloads the whole
433 page multiple times each time an item is scanned.
434 * Fixes an issue that displayed the oldest -- rather than the newest
435 -- transit in the Web staff client Item Status page.
436 * Fixes an issue that prevented the reports module from being displayed
438 * Fixes an issue in the Web staff client reports module that caused
439 syntax errors in reports that use virtual fields and joins.
440 * Fixes an issue that prevented several dropdown menus in the Web staff
441 client from activating.
442 * Fixes an issue that created duplicate copy data when copies or
443 volumes with parts were transferred.
444 * Fixes the Trim List feature in the Web staff client Check In screen.
445 * The Item Status grid now displays the Circulation Modifier.
446 * Restores missing data from the Profile column in Place Hold patron
448 * Fixes an issue with the http -> https redirect on Apache 2.4.
449 * Fixes an color contrast accessibility issue in the Web staff
450 client and adds underlining to links in grid cells for added accessibility.
451 * Adds automated regression and unit tests for the Web staff client
453 * Adds a process for spell-checking the official documentation.
454 * Adds a script that simplifies the release process related to translations.
459 We would like to thank the following individuals who contributed code,
460 tests and documentation patches to the 3.0.5 point release of
465 * Blake Graham-Henderson
480 This release contains bug fixes improving on Evergreen 3.0.3:
482 * Fixes a bug that caused all searches limited by shelving location to
484 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
485 rather than the ordering agency's SAN.
486 * Fixes a bug that prevented Safari/iOS users from logging in to the
488 * Fixes a bug that prevented users from using the browse interface.
489 * Fixes a bug in the Item Status List view that caused incorrect due
491 * Approval code is now a required field in the web client's patron
492 credit card payment form.
493 * Fixes a bug with credit card payments that caused a receipt to print
494 showing that the patron paid the bill when the payment had not actually
496 * Fixes a bug that prevented the EDI translator from being installed on
498 * Fixes a bug that caused entries to show up multiple times in the
499 Items Out and Holds tabs in the patron record.
500 * Fixes a bug that caused grids on Bills and Patron Messages
501 screens to not display properly.
502 * The following fields are now available for the Checkout and Items Out
509 ** money_summary.balance_owed
510 ** money_summary.total_paid
511 ** money_summary.total_owed
516 * The following fields are now available on the Bill Payment receipt templates:
526 * Payment type is now a column in the payments tab of the patron record
527 Bill History section.
528 * The "Replace Barcode" function now makes it more difficult for staff
529 members to attempt to create blank patron barcodes.
530 * The patron bills screen now prevents staff members from double-clicking
531 on the Apply Payment button (which otherwise would apply two payments).
532 * Fixes a bug that prevented patrons attached to statistical categories
533 from displaying in the patron search-to-hold dialog.
534 * Fixes a performance issue related to uploading CSV files of barcodes
535 to the item status and patron bucket interfaces.
536 * Fixes several small bugs in the Spanish translation.
537 * Fixes a performance bug related to patrons logging in by barcode.
541 We would like to thank the following individuals who contributed code,
542 tests and documentation patches to the 3.0.4 point release of
564 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
565 update the visibility attributes of all bibs that make use of Located URIs or
566 bib sources. It may take a while to run on large datasets. If it it running
567 too long, it can be canceled and the following psql commands will create and
568 run a script that will perform the same action serially over time without
569 blocking writes to bibs:
572 \o /tmp/luri_visibility_update.sql
573 SELECT 'UPDATE biblio.record_entry SET ' ||
574 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
575 'WHERE id = ' || id || '; SELECT ' || id || ';'
576 FROM biblio.record_entry
578 SELECT DISTINCT cn.record
579 FROM asset.call_number cn
581 AND cn.label = '##URI##'
584 FROM asset.uri_call_number_map m
585 WHERE m.call_number = cn.id
588 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
593 \i /tmp/luri_visibility_update.sql
596 It will output the id of each updated bib so that the script can be killed
597 and then edited to remove completed bibs. The remainder can be run at a
600 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
601 we do NOT update the bib's visibility attributes, as doing so causes a loop
602 and an eventual trigger stack violation. This flag should ONLY be used when
603 forcing reingest of record attributes (NOT visibility attributes), search,
604 facet, and display fields, so if using this flag under normal operation,
605 proceed at your own risk and know that Located URI and bib source changes
606 will not be reflected in the visibility attributes of the record.
610 This release contains several bug fixes improving on Evergreen 3.0.1:
612 * Fixes several issues related to the display of located URIs and records with
613 bib sources in search results.
614 * Setting `opac_visible` to false for a copy location group now hides only
615 the location group itself, rather than also hiding every single copy in the
617 * Fixes a bug that prevented the copy editor from displaying the _fine level_
618 and _loan duration_ fields.
619 * The "Edit Items" grid action in the Item Status interface will now open
620 in the combined volume/copy editor in batch. This makes the behavior
621 consistent with the "Edit Selected Items" grid action in the copy
623 * Staff members are now required to choose a billing type when creating a
624 bill on a user account.
625 * The Web client now provides staff users with an alert and option to
626 override when an item with the Lost and Paid status is checked in.
627 * Fixes a bug where the Web client offline circ interface was not able
628 to set its working location.
629 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
631 * The MARC editor in the Web staff client now presents bib sources in
633 * Both circulation and grocery bills are now printed when a staff user selects
634 a patron account and clicks "Print Bills".
635 * Fixes an issue in the XUL serials interface the "Receive move/selected"
636 action from succeeding.
637 * Fixes a typo in the user password testing interface.
641 We would like to thank the following individuals who contributed code,
642 tests and documentation patches to the 3.0.3 point release of
661 This release contains several bug fixes improving on Evergreen 3.0.1:
663 * Copy templates created in XUL Holdings Maintenance will now be
664 automatically converted and displayed in the web staff client's
666 * The list of report templates now includes a column indicating whether
667 the template was originally created in the XUL staff client or the web
668 staff client; staff need to know this since report templates created in
669 one interface cannot be edited in the other.
670 * Call number prefixes and suffixes are now displayed in various grids
671 in the web staff client, including
672 ** Pending Copy Buckets
674 ** Checkin/Capture Holds
676 ** Patron Bills History
683 ** Bib Record View Holds
685 * Many patron fields have been redacted from the web staff client's patron
686 and record holds grids, leaving patron name, username, and ID.
687 * Fixes two bugs where patron records could fail to be saved upon editing.
688 * The web staff patron editor now better warns staff users about
689 duplicate names, IDs, phone numbers, and email addresses.
690 * Human readable labels are now displayed for certain fields in standing
692 * The patron summary in the web staff client now correctly displays
693 primary and secondary ID values.
694 * The web staff client's billing full details page now displays
695 information about the staff user that created a payment.
696 * The web staff client now requires staff users to explicitly set a
697 billing type when adding a manual bill.
698 * The web staff client's patron bill annotation modal now works.
699 * Patron barcode search completion in the web staff client now allows
700 the user to select from all of the matching patron records.
701 * The Hold Shelf Slip print template in the web staff client now has
702 access to the call number.
703 * The Checkout Receipt print template in the web staff client now can
704 include summary financial information, incuding current balance, total
705 paid on outstanding fines, and total owed.
706 * The web staff print templates for current and historical bills can
707 now include copy barcode and title.
708 * Fixes a bug that resulted in some catalog searches unexpectedly
710 * Fixes a bug that resulted in catalog searches that specify a location
711 limit returning incorrect results.
712 * Fixes a bug where deleted copies could make records visible in the
714 * Fixes a bug where certain queries on copies used in the public catalog
716 * Fixes a bug place a hold request in the public catalog could result
717 in "forgetting" the type and library of the user's previous search.
718 * The web staff client now respects staff user session timeouts, and
719 will log out all open tabs if a user's session has timed out.
720 * The web staff Z39.50 page will now give the staff user an alert if
721 they attempt to import a record with a duplicate TCN.
722 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
723 entries from being deleted.
724 * Fixes a bug that made using the volume/copy editor to change a copy's
726 * The administration interface for hard due dates now ensures that
727 new (or edited) ceiling dates have their time component set to end
728 of day, resolving an issue where ceiling dates would not be applied
729 during the ceiling date itself.
730 * The web staff client can now include dynamic information in browser
731 tab titles, e.g., "Smith, Jane - Checkout".
732 * The Concerto sample data set now includes data allowing for testing
733 placing holds on monographic parts.
734 * Asset merging during bibliographic record merging now correctly
735 recognizes call number prefixes and suffixes and deletes disused
737 * Fixes a bug where displaying user surveys could result in PCRUD
739 * Fixes a bug where pg_restore of an Evergreen database could fail
740 to create certain indexes on the `actor.usr` table.
744 We would like to thank the following individuals who contributed code,
745 tests and documentation patches to the 3.0.2 point release of
776 This release contains several bug fixes improving on Evergreen 3.0.0
778 * Fixes a bug in the web staff client that prevented initials from being
779 stored with copy notes.
780 * Adds billing types that may have been missed by systems that were
781 running Evergreen prior to the 1.4 release.
782 * Fixes a web staff client bug with the CSV export option available from
783 the Import Queue in the MARC Batch Import/Export interface.
784 * Adds the missing copy alert field in the web client's volume/copy
786 * Fixes a bug where the setting to require date of birth in patron
787 registration was not being honored in the web staff client.
788 * Fixes a bug in the web staff client patron registration form where the
789 password wasn't generating from the last four digits of the patron's
791 * Fixes an issue in the web staff client where the complete barcode did
792 not display in some interfaces when partial barcodes were scanned.
793 * Fixes an HTML error in the new copy tags that display on the record
795 * Fixes a web staff client bug where recording a large number of in-house
796 uses at one time doesn't display a confirmation dialog once it hits the
798 * Adds a _Print Full Grid_ action in the web staff client
799 holds pull list to allow staff to print the entire pull list as it
800 displays on the screen. This change also changes the _Export CSV_ action
801 to an _Export Full CSV_ option.
802 * Fixes an issue with the Patron Messages interface that prevented it
803 from saving column configuration changes in the web staff client.
804 * Fixes a bug in the web staff client where a billing prompt did not
805 correctly display after marking an item damaged in those systems that
806 have enabled the setting to bill for damaged items.
807 * Adds an option to the specific due date feature that allows saving
808 that due date until logout. This allows all circulations from a given
809 workstation to be due on the same date.
813 We would like to thank the following individuals who contributed code,
814 tests and documentation patches to the 3.0.1 point release of
836 The minimum version of PostgreSQL required to run Evergreen 3.0 is
837 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
839 Change to Names of Shared Libraries
840 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
841 OpenSRF 3.0 changes how the shared libraries for services written in
842 C are named. If upgrading from an earlier version of Evergreen,
843 `opensrf.xml` should be edited so that shared library file names
844 listed in the `<implementation>` tag start with "lib". For example,
847 ---------------------------------------------------------------------
849 <language>C</language>
850 <implementation>oils_cstore.so</implementation>
851 ---------------------------------------------------------------------
853 should be changed to:
856 ---------------------------------------------------------------------
858 <language>C</language>
859 <implementation>liboils_cstore.so</implementation>
860 ---------------------------------------------------------------------
862 SIP Bugfix Requires SIPServer Upgrade
863 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
865 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
866 crash" requires that you also upgrade SIPServer with the fix for
867 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
868 SIP client problems." This means that if you use SIP2 with Evergreen,
869 you must also upgrade SIPServer to the latest commit in the Git
870 repository. Conversely, if you upgrade SIPServer to the latest commit
871 in Git, you must also upgrade Evergreen or, at least, apply the patch
872 for Launchpad Bug 1542495. These two patches are complementary and
873 cannot be applied independently of one another.
875 `open-ils.auth.login`
876 ~~~~~~~~~~~~~~~~~~~~~
877 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
878 API's in the `opensrf_core.xml` file.
883 ---------------------------------------------------------------------
884 --- a/Open-ILS/examples/opensrf_core.xml.example
885 +++ b/Open-ILS/examples/opensrf_core.xml.example
886 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
888 <match_string>open-ils.auth.authenticate.verify</match_string>
889 <match_string>open-ils.auth.authenticate.complete</match_string>
890 + <match_string>open-ils.auth.login</match_string>
891 <match_string>open-ils.auth_proxy.login</match_string>
892 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
893 <match_string>open-ils.actor.user.password</match_string>
894 ---------------------------------------------------------------------
898 Administrators of Evergreen who use RTL locales and who have customized
899 `style-rtl.css.tt2` should now incorporate their customizations into
902 Multi-Time Zone Installations
903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
905 For Evergreen consortia that span more than one time zone, the following
906 query will adjust all historical, unaged circulations so
907 that if their due date field is pushed to the end of the day, it is done
908 in the circulating library's time zone, and not the server time zone.
910 It is safe to run this after any change to library time zones.
912 Running this is not required, as no code before this change has
913 depended on the time string of '23:59:59'. It is also not necessary
914 if all of your libraries are in the same time zone, and that time zone
915 is the same as the database's configured time zone.
924 for ou_id in select id from actor.org_unit loop
925 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
926 if new_tz is not null then
927 update action.circulation
928 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
929 where circ_lib = ou_id
930 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
939 Deprecation of XUL staff client
940 -------------------------------
941 Starting with the release of 3.0.0, patches that fix XUL bugs will not
942 be merged into master or backported unless they meet one or more of
943 the following conditions:
945 a. the bug is a security issue
946 b. the bug involves the destruction of data
947 c. the bug is a regression of functionality in the XUL staff client
948 introduced by other work done to Evergreen
950 Under no circumstances will XUL staff client feature enhancements be merged.
952 This policy will continue through the 3.0.x and 3.1.x maintenance
953 release cycles, and will become moot upon the release of 3.2.0, when
954 the XUL staff client is slated to be entirely removed.
963 Evergreen 3.0 features a new, modern staff client that runs in the web browser
964 and can be used on desktop and mobile devices. All functional areas of the
965 system, including circulation, cataloging, acquisitions, serials, reports,
966 booking, administration, and offline circulation, are available in the new staff
967 client. Chrome and Firefox are officially supported for use with the web client.
969 Library staff will no longer need to download separate software to perform most
970 actions in Evergreen. A Chrome plugin called Hatch will be available as a
971 separate installation for workstations that require seamless, dialog-free
972 printing to multiple printers.
974 In addition to adding more portability and stability, the new staff client also
975 presents a cleaner and more modern interface for users. By virtue of running in
976 a browser, actions that users are accustomed to performing on other web sites
977 should now be available in the Evergreen client.
979 The old, XUL client will continue to be available to allow for a gradual
980 transition to the browser-based client, but no new features will be added. The
981 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
991 New EDI Order Generator
992 ^^^^^^^^^^^^^^^^^^^^^^^
997 . New database tables exist for configuring vendor-specific EDI order
1001 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1003 * `acq.edi_attr_set`
1004 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1006 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1007 the stock configuration found in the JEDI template.
1008 * `acq.edi_attr_set_map`
1009 ** Link between `edi_attr`s and `edi_attr_set`s.
1011 . EDI Attribute Sets are manged via a new (browser client only) configuration
1012 interface at 'Administration -> Acquisitions Administration -> EDI
1015 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1016 is not set, default values will be used. Links between an EDI account
1017 and an attribute set are managed in the EDI Accounts configuration
1020 . Local modifications to the stock EG JEDI template are managed by modifying
1021 and/or adding additional `edi_att_set`s as needed.
1023 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1024 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1026 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1027 definition is no longer required and can be disabled.
1032 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1033 specifies whether PO's generated via the account should be built using
1034 EDI attributes or fall back to traditional JEDI A/T template generation.
1036 This allows sites to activate EDI attributes on a per-account basis, making
1037 it possible to migrate piecemeal to EDI attributes. For the initial roll
1038 out of this new feature, no accounts will be configured to use EDI
1039 attributes by default.
1045 3 Day Courtesy Notice by SMS
1046 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1047 New optional SMS text notification to be sent out 3 days prior to the due
1048 date of any circulating item for patrons who have an SMS text number and
1049 carrier stored in their accounts. This action trigger is disabled by default,
1050 but can be enabled and modified by going into 'Administration -> Local Administration ->
1051 Notifications / Action Triggers'.
1053 You may wish to make use of granularity so that these messages are batched
1054 and sent at the same time each day.
1059 Add Description Field to Circulation and Hold Configuration Entries
1060 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1061 The circulation and hold policy configuration rules now each have a
1062 description field. This allows administrators to add comments to
1063 describe the purpose of each rule.
1068 Apache Internal Port Configuration Option
1069 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1070 Apache configuration now supports a new variable which allows admins to
1071 specify the port used by Apache to handle HTTP traffic. The value is
1072 used for HTTP requests routed from Perl handlers back to the same Apache
1073 instance, like added content requests. Use this when running Apache
1074 with a non-standard port, typical with a proxy setup. Defaults to "80".
1077 -------------------------------------------------------------------
1080 PerlSetVar OILSWebInternalHTTPPort "7080"
1083 -------------------------------------------------------------------
1088 Configurable Bib Record Display Fields
1089 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1091 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1092 fields: 'Display Field?' and 'Display XPath'.
1094 When 'Display Field' is set to true, data from the field will be extracted
1095 from each record and added to a new table of display data for each bib
1098 If a value is present in the 'Display XPath' field, this XPath will be
1099 applied to the extracted data *after* the base XPath (from the 'XPath'
1100 field) is applied to each field.
1102 This data acts as a replacement for the various and sundry ways bib record
1103 data is currently extracted, including inline XPath in the TPAC, reporter
1104 views, real-time 'MVR' compilation from MODS, etc. and will be available
1105 to the user interface, notification templates, etc. for rendering bib
1108 The browser client gets a new service 'egBibDisplay' which is capable
1109 of translating the display field data from various formats into
1110 data more suitable for JavaScript usage.
1112 The database gets 3 new views for representing display data in various
1115 * `metabib.flat_display_entry`
1116 ** List of all display fields linked to their configuration.
1117 * `metabib.compressed_display_entry`
1118 ** Same as `metabib.flat_display_entry` except there's one row
1119 per display field type, with 'multi' rows compressed into
1120 JSON arrays. Non-multi fields are represented as JSON
1122 * `metabib.wide_display_entry`
1123 ** Tabular view of display field data, one column per well-known
1124 field. Values are represented JSON, consistent with
1125 `metabib.flat_display_entry`. The view does *not* contain locally
1126 configured display fields, as each field must be encoded in
1127 the view and IDL definition. This is essentially a replacement
1128 for `reporter.simple_record`.
1133 After making changes to display field configuration, it's possible to
1134 reingest only display field data in the database using the following:
1137 ---------------------------------------------------------------------
1138 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1139 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1140 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1141 ---------------------------------------------------------------------
1147 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1148 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1149 The existing permission was incorrectly created with a code of
1150 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1151 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1152 update changes the permission code to match what the event requires.
1158 Hold Targeter V2 Repairs and Improvements
1159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1160 * Make the batch targeter more resilient to a single-hold failure.
1161 * Additional batch targeter info logging.
1162 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1163 * Removes the confusingly named `--target-all` option
1164 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1165 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1167 New --next-check-interval Option
1168 ++++++++++++++++++++++++++++++++
1169 Specify how long after the current run time the targeter will retarget
1170 the currently affected holds. Applying a specific interval is useful
1171 when the retarget-interval is shorter than the time between targeter
1174 For example, if the targeter is run nightly at midnight with a
1175 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1176 since the holds won't be processed again until 48 hours later. This
1177 ensures that the org unit closed date checks are looking at the correct
1180 This setting overrides the default behavior of calculating the next
1181 retarget time from the retarget-interval.
1183 New --soft-retarget-interval Option
1184 +++++++++++++++++++++++++++++++++++
1185 This is a replacement for (and rebranding of) the `--skip-viable` option.
1186 The new option allows for time-based soft-targeting instead simple binary
1187 on/off soft-targeting.
1189 How soft-targeting works:
1191 * Update hold copy maps for all affected holds
1192 * Holds with viable targets (on the pull list) are otherwise left alone.
1193 * Holds without viable targets are retargeted in the usual manner.
1199 New marc_export --descendants Option
1200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1202 The `marc_export` script has a new option, `--descendants`. This option
1203 takes one argument of an organizational unit shortname. It works much
1204 like the existing `--library` option except that it is aware of the
1205 org. tree and will export records with holdings at the specified
1206 organizational unit and all of its descendants. This is handy if you
1207 want to export the records for all of the branches of a system. You
1208 can do that by specifying this option and the system's shortname,
1209 instead of specifying multiple `--library` options for each branch.
1211 The `--descendants` option can be repeated, as the `--library` option can.
1212 All of the specified org. units and their descendants will be included
1213 in the output. It can also be combined with individual `--library`
1214 options when necessary.
1219 RTL and LTR Public Catalog Stylesheets Merged
1220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1221 The RTL stylesheet for the public catalog,
1222 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1223 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1224 template will provide RTL or LTR styles based on the value of
1225 the `rtl` flag of the active locale. An `rtl` variable is also available
1226 in the template to allow the correct style to be chosen.
1231 Miscellaneous Improvements
1232 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1234 * If a filter is in effect in the Library Settings Editor,
1235 the filter will continue to be applied after a user
1236 changes the selected library.
1237 * Copy templates used for serials now correctly link to age
1238 protection rules and MARC item type values (for the
1239 "Circ as Type" field). During upgrade, the database update
1240 will set to NULL any age protection and circ as type fields
1241 in serial copy templates that do not point to defined values.
1246 Obsolete Internal Flag Removed
1247 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1249 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1250 flag was removed from the `config.internal_flags` table. It was
1251 rendered obsolete by the addition of the 3 flags to control the
1252 browse, search, and facet indexing.
1257 Tweaks to Caching/Expiry of Public Catalog Assets
1258 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1259 The default cache expiration time for static assets (e.g.,
1260 CSS, image, and JavaScript files) in the public catalog and
1261 the Kid's PAC has been increased to one year. Links to all
1262 such assets now have a cache-busting value tacked on as a
1263 query parameter. This value is refreshed when `autogen.sh` is
1264 run, but it can also be manually set by adjusting the
1265 `ctx.cache_key` Template Toolkit variable.
1270 Action/Trigger Events Data Purging
1271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1273 Action/Trigger event definitions have a new field called 'Retention
1274 Interval'. When an optional interval value is applied, events and
1275 template output data linked to the event definition will be deleted
1276 from the database once they reach the specified age.
1278 Retention Interval Restrictions for Passive Hooks
1279 +++++++++++++++++++++++++++++++++++++++++++++++++
1281 Restrictions are placed on retention interval values for event definitions
1282 using passive hooks to prevent data from being deleted while it's still
1283 needed by the system.
1285 The presence of event data is how the system knows not to send duplicate
1286 events. As long as a scenario exists where a duplicate event may be
1287 generated, the events must be retained.
1289 To apply a retention interval value to a passive-hook event definition:
1291 * The event definition must have a max_delay value.
1292 * The retention interval must be larger than the difference between
1293 the `delay` and `max_delay` values.
1295 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1296 interval must be greater than 3 days to ensure no duplicate events are
1297 created between the first event on day 7 and the end of the event validity
1303 A new `purge_at_events.sh` script is installed in the bin directory
1304 (typically `/openils/bin`) which should be added to CRON for regular
1307 NOTE: On large data sets, this script can take a long time to run and
1308 create higher than normal I/O load as it churns though the event and
1309 event_output tables. You may wish to run the script by hand the first
1310 time so it can be monitored. It can be run in psql like so:
1313 ---------------------------------------------------------------
1314 SELECT action_trigger.purge_events();
1315 ---------------------------------------------------------------
1317 NOTE: On *very* large data sets (10s to 100s of millions of event and
1318 event_output rows), it may be advisable to first repopulate the `event`
1319 and `event_output` tables with only the desired data before starting
1320 regular purges. This can be done, for example, using the copy to temp
1321 table, truncate source table, repopulate source table from temp table
1322 approach. This will be much faster than the `purge_events()` function
1323 in cases where most of the data will be purged.
1328 A number of `action_trigger.hook` entries which have always been treated
1329 as active hooks, though are configured as passive hooks, have been
1330 updated to properly reflect the non-passive-ness. This allows for
1331 simpler configuration of their retention interval values.
1337 Remove JSPAC Redirects
1338 ^^^^^^^^^^^^^^^^^^^^^^
1339 Future versions of Evergreen will no longer contain automatic redirects
1340 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1341 that the JSPAC is no longer supported. Existing sites, however, may
1342 wish to retain JSPAC redirects in their Apache configuration files since
1343 JSPAC URLs may still be used in the wild to access their catalogs.
1345 The original JSPAC URL redirects are all retained in the file
1346 `Open-ILS/examples/jspac_redirects.conf` for reference.
1356 New open-ils.auth.login API
1357 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1358 The `open-ils.auth` service has a new API for requesting an authentication
1359 token. It performs the same steps as the
1360 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1361 using the bare password. No intermediate password hashing is required.
1363 The paramaters are the same as the `.complete` call with a few modifications.
1365 1. Using the generic 'identifier' parameter in combination with the
1366 'org' parameter allows the API to reliably determine if an identifier
1367 value is a username or barcode. The caller is no longer required to
1368 make that determination up front.
1370 2. The 'nonce' parameter is no longer used.
1376 Batch Patron Contact Invalidation
1377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1378 The following methods are used to mark patron contact fields
1379 as invalid by moving the invalid value to a standing penalty:
1381 * `open-ils.actor.invalidate.email`
1382 * `open-ils.actor.invalidate.day_phone`
1383 * `open-ils.actor.invalidate.evening_phone`
1384 * `open-ils.actor.invalidate.other_phone`
1386 These methods now accept a fifth argument specifying the value
1387 of the contact field, e.g., a specific phone number or email
1388 address. If supplied, and if a specific patron ID (the first
1389 argument) is not supplied, all patrons with that specific contact
1390 value will have it marked invalid.
1400 Pure-SQL catalog searching
1401 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1402 Public and staff catalog search is now both more accurate and faster
1403 by redesigning how the visibility of records is calculated.
1413 Authority Record and Headings Browse Improvements
1414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1415 Various improvements are made to support for authority records
1416 and headings browsing:
1418 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1419 headings from authority records. Since the MODS and MADS stylesheets
1420 extract headings in similar ways, duplicate browse entries are now
1421 much less likely to occur.
1422 * A new configuration table, `authority.heading_field`, is now used
1423 to specify how headings should be extracted from authority records.
1424 * Related headings can now be identified as narrower or broader when
1425 browsing in the public catalog.
1426 * See references are now more reliably included in the browse list.
1427 * Scope (public) notes now display only under the main heading.
1428 * There is now a global flag, Display related headings (see-also) in browse,
1429 that can be used to control whether related headings (see-alsos) are
1430 displayed in the public catalog list.
1431 * A complete set of thesauruses are now included in the seed data. Thesauruses
1432 can now be identified using short and long codes.
1433 * The labels for see and see-also references in the public catalog are
1434 a bit more patron-friendly, and can now be tweaked via TPAC template
1435 customization in the browse.tt2 file.
1441 Copy Tags and Digital Bookplates
1442 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1443 Copy tags will allow staff to apply custom, pre-defined labels or tags
1444 to copies. Copy tags are searchable in both the staff client and public
1445 catalog. This feature was designed to be used for Digital Bookplates to
1446 attach donation or memorial information to copies, but may be used for
1447 broader purposes to tag items.
1449 Each copy tag can either be publicly-visible or visible only to staff.
1450 Copy tags also have types that can be used for restricting catalog
1451 searches on copy tags to particular types.
1453 Copy tags are displayed in the copy table in the record summary page in
1454 the public catalog, and a new library setting can be used to add
1455 a "Digital Bookplate" search field. Copy tags can also be used
1456 as a search filter, e.g.,
1458 * `copy_tag(bookplate, jane smith)`: search for records that have a
1459 copy tag of type 'bookplate' whose value contains 'jane smith'.
1460 * `copy_tag(*, jane smith)`: search for records that have a
1461 copy tag of any type whose value contains 'jane smith'.
1463 All staff-side interfaces related to copy tags exist only in the web
1464 staff client. There are two new administration interfaces for managing
1465 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1466 button for applying copy tags to copies; that interface can also be
1467 used to create new copy tags on the fly. Furthermore, the copy buckets
1468 interface now has an 'Apply Tags' action for assigning tags to groups
1474 Two new permission are included:
1476 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1477 'Administration -> Server Administration -> Copy Tag Types'
1478 * `ADMIN_COPY_TAG`: required to create a new tag under
1479 'Administration -> Local Administration -> Copy Tags'
1481 The existing permission `UPDATE_COPY` controls whether or not a user
1482 can link copies to tags.
1486 A new library setting, 'Enable Digital Bookplate Search', controls
1487 whether to display a 'Digital Bookplate' field in the search index
1488 drop-downs in the catalog. A 'Digital Bookplate' search will include
1489 all records that have a copy that matches the tag specified by the user.
1490 It should be noted that this library setting does not affect the
1491 display of copy tags on the catalog record summary page.
1496 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1497 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1498 The call number prefix and suffix, when present, are now included in
1499 subfields $k and $m of the 852 field when running `marc_export` with
1500 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1501 server configured to embed item data in 852 fields, the affixes are now
1502 included in subfields $k and $m.
1512 Batch Editing of Patron Records
1513 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1514 There is a now a new interface analogous to the Copy Bucket interface
1515 to select and group a set of users into a User Bucket.
1516 The addition of users to a User Bucket is possible from the Patron Search
1517 interface by the use of a new grid Action, and directly on the User Bucket
1518 interface by user barcode. It is also possible to add users to a User
1519 Bucket by uploading a text file that contains a list of user barcodes.
1521 From this interface it is possible to perform a set of specific batch update
1522 operations on user records.
1527 These fields can now be changed in batch via an action on the User Bucket
1528 grid if the staff user has the `UPDATE_USER` permission:
1531 * Primary Permission Group (group application permissions consulted)
1533 * Home Library (`UPDATE_USER` checked against both old and new value)
1534 * Privilege Expiration Date
1535 * Barred flag (`BAR_PATRON` permission consulted)
1536 * Internet Access Level
1538 Changes made in this interface can be rolled back.
1540 As a batch process, rather than a direct edit, this mechanism explicitly skips
1541 processing of Action/Trigger event definitions for user update.
1546 The batch edit mechanism also allows for the batch deletion of user. The staff
1547 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1549 Changes made in this interface can be rolled back.
1551 As a batch process, rather than a direct edit, this mechanism explicitly skips
1552 processing of Action/Trigger event definitions for user deletion.
1554 This mechanism does not use the Purge User functionality, but instead simply
1555 marks the users as deleted.
1557 Editing Statistical Category Entries
1558 ++++++++++++++++++++++++++++++++++++
1560 All users in the bucket can have their Statistical Category Entries
1561 modified. Unlike user data field updates, modification of Statistical
1562 Category Entries is permanent and cannot be rolled back.
1564 As a batch process, rather than a direct edit, this mechanism explicitly skips
1565 processing of Action/Trigger event definitions for user update.
1567 New Service Requirement
1568 +++++++++++++++++++++++
1570 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1571 unused in production. If this service has been removed from the configuration
1572 of a live Evergreen instances, it will need to be added back in order for
1573 batch user editing to succeed.
1578 Honor Timezone of the Acting Library
1579 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1584 * Display day-granular due dates in the circulating library's timezone.
1585 * Only display the date portion of the due date for day-granular circulations.
1586 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1587 * Provide infrastructure for more advanced formatting of timestamps.
1588 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1593 This is a followup to the work done for 2.12, where we added the ability
1594 for the client to specify a timezone in which timestamps should be interpreted
1595 in business logic and the database.
1597 Most specifically, this work focuses on circulation due dates and the closed
1598 date editor. Due dates, where displayed using stock templates (including
1599 receipt templates) and used for fine calculation, are now manipulated in the
1600 library's configured timezone. This is controlled by the new 'lib.timezone'
1601 setting available via the Library Settings Editor, loaded from the server when
1602 required. Additionally, closings are recorded in the library's timezone so that
1603 due date calculation is more accurate. The closed date editor is also
1604 taught how to display closings in the
1605 closed library's timezone. Closed date entries also explicitly record if they
1606 are a full day closing, or a multi-day closing. This significantly simplifies
1607 the editor, and may be useful in other contexts.
1609 To accomplish this, we use the moment.js library and the moment-timezone addon.
1610 This is necessary because the stock AngularJS date filter does not understand
1611 locale-aware timezone values, which are required to support DST. A simple
1612 mapper translates the differences in format values from AngularJS date to
1615 Of special note are a set of new filters used for formatting timestamps under
1616 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1617 filters provide the functionality, and autogrid is enhanced to make use of
1618 these where applicable. egGrid and egGridField are also taught to accept
1619 default and field-specific options for applying date filters. These filters may
1620 be useful in other or related contexts.
1622 The egDueDate filter, used for all existing displays of due date via Angular
1623 code, intentionally interprets timestamps in two different ways WRT timezone,
1624 based on the circulation duration. If the duration is day-granular (that is,
1625 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1626 of seconds) then the date is interpreted as being in the circulation library's
1627 timezone. If it is an hourly loan (any duration that does not meet the
1628 day-granular criterium) then it is instead displayed in the client's timezone,
1629 just as all other timestamps currently are, because of the previous Evergreen
1632 The public catalog is adjusted to always display the due date in the circulating
1633 library's timezone. Because the public catalog displays only the date portion of the due
1634 date field, this difference is currently considered acceptable. If this proves
1635 to be a problem in the future, a minor adjustment can be made to match the
1636 egDueDate filter logic.
1638 Now that due dates are globally stored in the configured timezone of the
1639 circulating library, the automatic adjustment to day-granular due dates needs
1640 to take those timezones into account.
1642 An optional SQL command is provided by the upgrade script to retroactively
1643 adjust existing due dates after library configuration is complete.
1649 Enhancements to Hard Due Date Functionality
1650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1651 It will now be possible to delete Hard Due Date Values for dates that have
1652 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1653 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1654 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1659 Patron Search by Birth Date
1660 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1661 * Now you can include the patron birth year and/or birth month and/or
1662 birth day when searching for patrons using the web staff client.
1663 * Day and month values are exact matches. E.g. month "1" (or "01")
1664 matches January, "12" matches December.
1665 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1666 1915, 1599, etc. For exact matches use the full 4-digit year.
1670 Patron Search from Place Hold
1671 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1672 This feature allows staff members, when placing a
1673 hold on behalf of a patron in the web staff client, to search for
1674 patrons by names and other searchable patron information, rather than
1675 relying on barcode alone. In particular, after performing a catalog
1676 search or going to a specific bib record and clicking the 'Place Hold'
1677 button, the form now includes a 'Patron Search' button. This button
1678 will open a dialog allowing the staff member search for and select
1684 Retrieve Recent Patrons
1685 ^^^^^^^^^^^^^^^^^^^^^^^
1687 Adds a new library setting 'Number of Retrievable Recent Patrons'
1688 ('ui.staff.max_recent_patrons') that specifies the number of recently
1689 retrieved patrons that can be re-fetched from the staff client.
1691 A value of 0 means no recent patrons can be retrieved.
1692 A value greater than 1 means staff will be able to retrieve multiple
1693 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1695 The default value is 1 for backwards compatibility.
1702 Fuller title in XUL client Simplified Pull List
1703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1704 The Simplified Pull List in the XUL client will now display subfields 245$n and
1705 $p in the title field. The addition will make it easier for staff to distinguish
1706 between different parts or seasons in a series.
1712 Transit Cancel Time and Terminology Change
1713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1718 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1719 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1720 are preserved in the database, though still not visible to the end user in the staff client.
1721 This allows for better tracking of when transits are canceled for the purposes of knowing
1722 which staff member canceled the transit, etc.
1724 NOTE: This change may require the re-creation of transit reports to filter out canceled
1725 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1726 Is NULL' will suffice.
1728 "Canceled Transit" Terminology Change
1729 +++++++++++++++++++++++++++++++++++++
1731 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1732 For internal continuity, however, the following permission codes have not changed:
1735 * `ABORT_REMOTE_TRANSIT`
1736 * `ABORT_TRANSIT_ON_LOST`
1737 * `ABORT_TRANSIT_ON_MISSING`
1745 Offline Circulation Available in Web Staff Client
1746 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1747 Offline circulation is now available in the web staff client. In order to use the
1748 offline interface, users must first log into the web staff client, perform
1749 a patron search, select a user from the results, and open the patron editor
1750 interface to collect all the relevent configuration information for the
1751 workstation. In addition, the offline interface available from the Circulation
1752 menu provides a 'Download block list' button for users who are logged in.
1754 As is the case in the old staff client, users can check materials in and out,
1755 renew items, and create new patron accounts while offline. The patron fields
1756 available in the offline patron registration editor are the same ones that
1757 are available to staff when working online.
1761 Add Circ Modifier to Record Detail Page in Staff TPAC
1762 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1763 The circulation modifier field is added to the table of copies to make
1764 more information available to staff without having to open
1771 Date+Time Format Settings for Web Client
1772 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1774 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1775 and adds two settings for use with the webstaff client:
1777 * 'Format Dates with this pattern'
1778 * 'Format Date+Time with this pattern'
1780 These settings use format strings as documented here:
1782 https://docs.angularjs.org/api/ng/filter/date
1784 There is overlap with how the Dojo formats worked, but also some differences.
1786 The original 'Format Dates' and 'Format Times' settings worked together, but the
1787 new settings work independently. Certain field elements will use one, and
1788 certain field elements will use the other. These distinctions are hard-coded
1789 in the various UI templates, with the idea being that timestamp fields in
1790 which the date component alone is sufficient information (for example, date of birth)
1791 will use the 'Format Dates' setting. Fields where the time component is
1792 important (for example, checkout time) will use the 'Format Date+Time' setting.
1794 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1795 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1801 Global Option to Remove Sound for a Specific Event
1802 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1803 A new `nosound.wav` file has been added to the web client. The file can be used
1804 to globally disable audio alerts for a specific event on an Evergreen system.
1806 For example, to silence the alert that sounds after a successful patron search:
1810 mkdir -p /openils/var/web/audio/notifications/success/patron/
1811 cd /openils/var/web/audio/notifications/success/patron/
1812 ln -s ../../nosound.wav by_search.wav
1819 The official Evergreen manual has been split into eight new manuals, each
1820 designed for a specific audience. This new approach is designed to make
1821 the documentation more readable and usable.
1823 The specific audiences for the new manuals are:
1825 * Acquisitions staff
1828 * Public services staff who use the public catalog
1830 * System administrators who use the command line
1831 * System administrators who use the Web client
1832 * System administrators and programmers who wish to integrate Evergreen
1833 with other technologies
1835 All manuals are available at http://docs.evergreen-ils.org
1841 Improvements to ebook API
1842 ^^^^^^^^^^^^^^^^^^^^^^^^^
1844 Evergreen now supports checking out and placing holds on
1845 OverDrive and OneClickdigital ebook titles from within the public
1846 catalog. This is an experimental feature. It is not recommended for production
1847 use without careful testing.
1849 When ebook integration is enabled, a "Check Out E-Item" link will be
1850 displayed when viewing an ebook title from a supported vendor in the
1851 catalog. Clicking on the link allows the user to check out and download
1852 that title from the vendor directly within the catalog.
1854 If no copies are available for the title, a "Place Hold on E-Item" link
1855 is displayed instead, and the user may place a hold on the title. (Note
1856 that some vendors require the user's account to have an email address
1857 before permitting a hold.)
1859 My Account includes the ability to view current ebook checkouts and
1860 holds, download already-checked-out titles, and cancel holds.
1862 For API integration to work, you need to request API access from the
1863 vendor, and the vendor must have a way of authenticating your patrons.
1864 Your Evergreen system also needs to be configured for ebook API
1865 integration, following the instructions in the command line system
1866 administration manual
1869 This feature assumes that you are importing MARC records supplied by the
1870 vendor into your Evergreen system, using Vandelay or some other MARC
1871 import method. This feature does not search the vendor's online
1872 collections or automatically import vendor records into your system; it
1873 merely augments records that are already in Evergreen.
1875 Improvements to Bill Payment Pages
1876 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1877 The bill payment pages in the public catalog have been revamped
1880 * use the term "charges" instead of "fees"
1881 * include images of credit cards accepted
1882 * make the default print receipt template match other itemized receipts;
1883 note that this change is not automatically applied when upgrading.
1884 * display billing type
1885 * add button to pay only selected charges
1886 * reformat the credit card number input page
1892 Clickable Copy Locations
1893 ^^^^^^^^^^^^^^^^^^^^^^^^
1894 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1895 the associated copy location will display as a link in the public catalog summary display.
1896 This link can be useful for retrieving maps or other directions to the copy
1897 location to aid users in finding material.
1902 Download Checkout History CSV Fixed for Large Number of Circulations
1903 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1904 Downloading checkout history as a CSV from My Account has been fixed
1905 for users with a large circulation history. Previously, this would
1906 time out for patrons with more than 100 or so circulations.
1908 This feature no longer uses the action/trigger mechanism and the public catalog
1909 now generates the CSV directly. The old action/trigger code is still
1910 present in the database and should be removed at some point in the
1916 Google Books Preview Rewrite
1917 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1918 The Google Books Preview functionality in record detail pages has been
1919 rewritten to modernize its style and optimize its performance:
1921 * The Dojo JavaScript framework is no longer used, saving approximately
1922 150K of JavaScript and CSS and four network requests per page load.
1923 * The Embedded Viewer is not loaded unless a possible preview is found,
1924 saving more network and memory overhead.
1925 * The Google Books Loader is used to load the Embedded Viewer instead of the
1926 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1928 * All variables are self-contained and do not pollute the global namespace.
1929 * Event listeners are registered to handle clicks, rather than attaching
1930 `href="javascript:function()"` to <a> elements.
1931 * Book previews are displayed in a panel sized according to the viewport
1932 of the browser, improving its appearance on both mobile and desktop
1934 * The rewritten code is now served up directly from
1935 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1940 jQuery for the Public Catalog
1941 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1942 This release adds optional support for jQuery in the public catalog. This support
1943 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1944 `config.tt2` template.
1950 New Popularity Parameters
1951 ^^^^^^^^^^^^^^^^^^^^^^^^^
1952 New popularity parameters for in-house use over time and for count of distinct
1953 organizational units that own a title are now available. Evergreen sites
1954 can use these parameters to create new statistical popularity badges for
1955 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1957 The in-house use parameters will apply a badge to titles that have the most
1958 in-house use activity over time. The organizational unit count parameter
1959 will apply a badge to titles owned by the most number of libraries in a
1960 consortium. Ownership is determined by the copy's circulation library.
1965 Option to Suspend Holds at the Time They are Placed
1966 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1967 Users now have the option to suspend a hold at the same time they place the
1968 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1969 who want to suspend a hold at the time it is placed. There is also an option
1970 to set the activation date at the same time. This option is also available
1971 when placing holds on a batch of titles from 'My List' and will apply to
1972 all the titles in the batch.
1983 Fix to reporter.classic_current_circ View
1984 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1985 The `reporter.classic_current_circ` view, which is part of some
1986 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1987 has been fixed to not exclude loans for patrons who do not have a
1988 billing address set. Users of this view should rerun
1989 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1994 New Report Source Table Allowing Report of "Last" Deleted copy
1995 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1997 This source table allows you to construct a clever aggregate report template
1998 which will report bibliographic IDs where a library or a group of libraries
1999 no longer have a copy attached but *had* a copy attached. This is especially
2000 useful when a holdings sync is required with an external vendor.
2003 Instructions for creating a report template with this source:
2005 * Create a new report template using "Library Holdings Count with Deleted" as the source
2006 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2007 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2008 * 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"
2009 * Add "Bib ID" to Displayed Fields
2010 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2011 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2012 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2015 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2016 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2017 specified date range. Unfortunately the user will have to manually type the date range without the date
2018 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2019 copy and more than two deleted copies."
2024 Add Provider to Provider Note Link
2025 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2026 The Provider reporting source now includes a link to the Provider Note reporting source.
2031 Link ILS User and Working Location Reporting Sources
2032 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2033 The Working Location reporting source now has labels
2034 and it is now linked to the ILS User reporting source, allowing
2035 reports to display or filter on staff working location.
2040 New Circulation Report Source "All Circulation Combined Types"
2041 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2043 This report source will allow you to create a single report template for all of the following:
2046 * In-house uses of non-cataloged items
2048 * Circulations of non-cataloged items
2050 To distinguish between these different types of library use, it's important to display these columns
2051 in your report templates:
2060 Reports Template Searching
2061 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2062 A new form appears along the top of the reports interface for searching
2063 report templates. Once found, typical template actions (e.g. create new
2064 report) are available from within the results interface.
2066 Searches may be performed across selected (visible) folders or all
2067 folders visible to the logged in user.
2069 Searches are case-insensitive, any word order, with left-anchored words.
2070 All searched words must appear in at least one of the searched fields.
2075 * Searching for 'stat cat' matches:
2077 ** statistical category
2078 ** categories, statistical
2079 ** patrons (stat cat)
2080 * Searching for 'stat cat' does not match:
2082 *** both words must be present in the searched field(s)
2084 *** location contains 'cat' but it's not left-anchored.
2089 The templates, reports, and output interfaces now support paging via
2090 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2102 Web Staff Client Serials Module
2103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2104 The serials module has been ported over to the web staff
2105 client, implementing a unified serials interface that combines
2106 ideas from both the serial control view and alternate serials
2107 control view from the old staff client.
2109 In addition to carrying over functionality that was available
2110 in the old staff client, several new features are included:
2112 * the ability to save prediction pattern codes as templates
2113 that can be shared and reused within an Evergreen database
2114 * a more streamlined interface for managing subscriptions,
2115 distributions, and streams
2116 * it is no longer necessary to create a starting issue in
2117 order to predict a run of issues; the dialog box for
2118 generating a set of predicted issues now lets you specify
2119 the starting point directly.
2120 * the ability to more directly edit MFHDs
2122 The new serials interfaces can be accessed from the record
2123 details page via a Serials drop-down button that links to
2124 a subscription management page, a quick-receive action, and
2125 a MFHD management page. There is also a new 'Serials Administration'
2126 page where prediction pattern and serial copy templates can
2137 SIP Bugfix Changes How Encoding Is Determined in Configuration
2138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2140 The combined fix for the above mentioned SIP bugs alters the way that
2141 SIPServer looks up the output encoding in the configuration file (typically
2142 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2145 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2146 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2147 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.
2148 4. If none of the above exist, then the default encoding (ASCII) is used.
2150 Number 3 is provided to ease the transition to the new code. It is
2151 the current location of the +encoding+ element in the sample
2152 configuration file and as such, where it is likely to be found in
2153 actual files. It is recommended that you alter your configuration to
2154 move this element out of the +implementation_config+ element and into
2155 its parent +institution+ element. Ideally, SIPServer should *not* look into
2156 the implementation config, and this check may be removed at some time
2164 Web Client Acknowledgments
2165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2167 The project to develop a new browser-based web client launched four
2168 years ago at the September 2013 Evergreen developer hack-a-way when the
2169 developer community voted to move away from the XUL client and explore other
2170 platforms. The first web client preview became available in Evergreen 2.7 when
2171 circulation was available in the new platform.
2173 The browser-based client is available due to the work of many coders, testers,
2174 bug reporters, documentors, translators, project managers, spec writers, funders
2175 and other contributors over the past four years.
2177 The Evergreen project would like to acknowledge the following organizations
2178 that funded development of the Web Staff Client:
2181 * British Columbia Libraries Cooperative
2182 * Consortium of Ohio Libraries
2184 * Georgia Public Library Service
2185 * Grand Rapids Public Library
2187 * Kenton County Public Library
2188 * King County Library System
2191 * Pennsylvania Integrated Library System
2192 * Pioneer Library System
2195 The Evergreen project would also like to thank the following individuals who
2196 contributed code, translations, documentation patches, tests, bug reports,
2197 technical specifications, and project management to the Web Staff Client:
2234 * Freddy Enrique Pelayo Huapalla
2260 Evergreen 3.0 Acknowledgments
2261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2263 The Evergreen project would like to acknowledge the following
2264 organizations that commissioned developments in this release of
2268 * British Columbia Libraries Cooperative (BC Sitka)
2270 * Georgia Public Library Service
2271 * King County Library System
2273 * Pennsylvania Integrated Library System
2274 * Pioneer Library System
2276 We would also like to thank the following individuals who contributed
2277 code, translations, documentation patches, and tests to this release of
2326 We also thank the following organizations whose employees contributed
2329 * British Columba Libraries Cooperative
2333 * Emerald Data Networks, Inc.
2334 * Equinox Open Library Initiative
2336 * Grand Rapids Public Library
2337 * Indiana State Library
2339 * King County Library System
2340 * Lake Agassiz Regional Library
2341 * Laurentian University
2342 * Linn-Benton Community College
2344 * Merrimack Valley Library Consortium
2346 * North of Boston Library Exchange
2347 * Pennsylvania Integrated Library System
2348 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2350 * Traverse Area District Library
2352 We regret any omissions. If a contributor has been inadvertently
2353 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob