1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.9. Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
14 * Fixes right-click issues with the Web client grids
15 * Fixes an issue with the Default SMS Carrier in the patron edit form.
16 * Fixes an issue that allowed overdue notices to be sent to a patron
17 whose long overdue item has been paid for.
18 * Checking in precat items now displays the "Route to Cataloging" alert each
19 time the item is checked in.
20 * Fixes an issue in which the Adjust to Zero feature
21 does not close a checked-in lost circ.
22 * Deleted copies that are still checked out can now be checked in.
23 * Fixes a mislabeled column in the patron checkout grid.
24 * Fixes an error with the missing pieces functionality.
25 * Courier codes now display in the transit slip receipt preview.
26 * The Item Status grid now displays OU shortnames instead of full names
27 for the "Circulation Library" column.
28 * The Volume/Copy editor now allows users to remove a value from the Age
29 Hold Protection field.
30 * Barcode completion now works in copy buckets.
31 * The Z39.50 interface now notices when another record has been marked
33 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
35 * Fixes a performance issue for the Validate button in the MARC Editor.
36 * Fixes an incorrect close tag in the Print Item Labels toolbar.
37 * Better scoping of copy tags in search results.
38 * Electronic Resource links now open in a new tab.
39 * Fixes an issue with the fiscal year close-out operation.
43 We would like to thank the following individuals who contributed code,
44 tests and documentation patches to the 3.0.10 point release of
69 This release contains bug fixes improving on Evergreen 3.0.8. Note that
70 all bug fixes refer to the web staff client unless otherwise specified.
75 * Fixes specific cases in which deleted records appear in search results.
76 * Fixes a performance issue with deleting patrons.
77 * The hold shelf dialog popup now lists the patron's notification
79 * Fixes an issue that prevented editing items when a monograph part
81 * Patron information is now available for use in the bills_current
82 and bills_historical receipt templates.
83 * The browser's "This page may contain unsaved data" warning now
84 appears when users click the update
85 expire date button in a patron account and attempt to navigate away
87 * The holds tab of the patron record now includes a monograph part
89 * The barcode box in the checkout screen
90 no longer hovers above patron record tabs when
91 staff users scroll down.
92 * Fixes an issue with the date of birth in the patron edit scren.
93 * Fixes an issue with the dropdown of billing type options.
94 * The Item Status screen now includes as a floating group column.
98 We would like to thank the following individuals who contributed code,
99 tests and documentation patches to the 3.0.9 point release of
102 * BC Libraries Cooperative
108 * Blake Graham-Henderson
125 This release contains bug fixes improving on Evergreen 3.0.7. Note that
126 all bug fixes refer to the web staff client unless otherwise specified.
134 * The MARC editor now handles 008 fields better.
135 * Adds spaces between subfields when suggesting a call
136 number for a new volume.
137 * MarcXML exports from the MARC Batch Import/Export ->
138 Export Records screen now downloads the file, rather than opening
140 * The Item Status Circulation Library column now displays a
141 shortname rather than the full library name.
142 * The Item Status Remaining Renewals column now displays
144 * The Item Status now has a "Last Renewal Workstation" column
146 * Fixes the circulation counts displayed in Item Status Details.
147 * Fixes an issue where multiple copies with different values for required
148 statistical categories could not be edited and saved in batch.
149 * Add an option to remove floating in the copy editor.
150 * Fixes an issue with the floating dropdown in the copy editor.
151 * Fixes a problem in which the copy template didn't properly copy
153 * Reduces the number of API calls that the MARC Editor requires.
158 * Fixes an issue that prevented the offline patron registration
160 * Fixes an issue with searching patrons by permission group.
161 * The barcodes in the patron search are now clickable.
162 * Staff members can now manually override the patron juvenile
163 flag value, regardless of the patron's date of birth.
164 * Checkboxes on patron registration screen are now properly aligned
166 * The user permission group dropdowns in the patron registration,
167 edit, and search interfaces now have scrollbars.
168 * The date picker on the checkout screen is now hidden unless
169 circ staff activates a specific due date option.
170 * The check-in screen now includes a copy status column.
171 * The Merge Patrons interface now displays the date of birth.
172 * The user bucket screen now displays the Bucket ID.
173 * The payment button on patron bills screen is now inactive if the
174 Payment Received field is blank.
175 * The Bill History receipt now includes a Finish date and a Last
177 * When a patron summary contains an image of the patron,
178 that image tag now has a null alt attribute to remove it from
179 the flow of a screen reader.
180 * Corrects an issue that caused the transit dialog to show the
182 * Corrects an issue with printing transit lists.
183 * "Find another target" on transiting hold no longer leaves the
185 * The images now display to distinguish hold and transit slips.
186 * The Clearable Holds list printout now only shows holds that have
188 * Restores the call number prefix and suffix fields to the holds
190 * The documentation at the top of the hold shelf slip template
192 * The cursor in the in-house use screen now automatically goes
193 to the barcode field.
194 * The in-house use screen now shows a copy status column.
195 * Add support for converting change to patron credit in the patron bills
196 interface, consistent with the XUL feature.
197 * Fixes a bug that caused pickup/request library fields to be
199 * Fixes a bug in the offline org unit tree.
201 Command-line system administration
202 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
204 * The novelist entry in `eg_vhost.conf` includes two new
206 * Corrects an issue with the `--max-sleep` argument on the
207 `action_trigger_runner.pl` support script.
208 * Corrects an issue with how the `eg_pbx_allocator.pl` script
209 detects an existing lock file.
210 * The 3.0.2-3.0.3 upgrade script disables triggers before
211 recalculating bib visibility.
216 * Fixes an issue that caused records with located URIs to be
217 retrieved in Copy Location and Copy Location Group searches.
218 * Fixes an error message that appeared in the search box
219 in the public catalog while placing hold after an advanced search.
220 * Restores the display of copy information for the user's
221 preferred library in the public catalog.
222 * Fixes regression errors in the search results page.
223 * Removes redundant call numbers from the Show More Details
225 * The cast field in the catalog is now taken from the 511 field
226 when first indicator = 1, rather than the 508.
227 * Fixes a display issue caused by editing holds.
232 * Fixes an issue that prevented users from searching for
233 receivable issues using Database ID or ISSN in the Serials
234 Batch Receive interface.
239 * Adds some padding to the bottom of Web Client interfaces.
240 * Logins now honor all org unit timeout settings.
241 * Evergreen will now identify and handle invalid timezones.
242 * Fixes an issue where a column header in some interfaces were automatically
243 highlighted in green when retrieving the interface.
244 * The parts column in the Item Status screen now displays parts data.
250 We would like to thank the following individuals who contributed code,
251 tests and documentation patches to the 3.0.8 point release of
286 This release contains bug fixes improving on Evergreen 3.0.6.
288 * Fixes a performance issue with the Patron Billing History screen and
289 other screens that cause Flattener.pm to re-create joins
291 * Fixes an issue that prevented patron alerts from showing to staff at
296 We would like to thank the following individuals who contributed code,
297 tests and documentation patches to the 3.0.7 point release of
309 This release is a security release that fixes cross-site scripting
310 (XSS) vulnerabilities in the Evergreen public catalog. This release
311 also includes several other bugfixes improving on Evergreen 3.0.5.
313 Security Issue: XSS Vulnerability in Public Catalog
314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
315 This release fixes several cross-site scripting (XSS) vulnerabilities
316 in the public catalog. When upgrading, Evergreen administrators should
317 review whether any of the following templates have been customized
318 or overridden. If so, either the template should be replaced with the
319 stock version or the XSS fix (which entails adding the `| html` filter
320 in several places) applied to the customized version.
322 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
323 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
324 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
326 Note that exploiting the XSS vulnerabilities fixed in this release
327 would require either the ability to create maliciously-constructed
328 MARC bibliographic or holdings records or the ability to set a
329 maliciously constructed organizational unit name.
333 Evergreen 3.0.6 also includes the following changes:
335 * When using 'Selection Lists -> Edit MARC Order Record' in the web
336 staff client, now only one click is required to save the MARC
337 record rather than two.
338 * The volume/copy editor in the web staff client now better handles
339 editing multiple items that have different sets of statistical
340 category values assigned to them.
341 * The act of merging bibliographic records now updates bookbags
342 that referred to the source bibliographic record rather than
343 effectively deleting entries for that record.
344 * Additional columns were added to the Holds Pull List in the
346 * The patron registration form in the web staff client now correctly
347 manages setting user preferences.
348 * An error in a pgTAP unit test was corrected.
352 We would like to thank the following individuals who contributed code,
353 tests and documentation patches to the 3.0.6 security release of
369 This release contains bug fixes improving on Evergreen 3.0.4.
371 * The MARC Editor in the Web staff client now wraps long fields.
372 * The MARC Editor no longer allows catalogers to enter new lines
374 * Fixes an issue that prevented serials items from being deleted or
376 * The Web staff client Check In screen no longer reloads the whole
377 page multiple times each time an item is scanned.
378 * Fixes an issue that displayed the oldest -- rather than the newest
379 -- transit in the Web staff client Item Status page.
380 * Fixes an issue that prevented the reports module from being displayed
382 * Fixes an issue in the Web staff client reports module that caused
383 syntax errors in reports that use virtual fields and joins.
384 * Fixes an issue that prevented several dropdown menus in the Web staff
385 client from activating.
386 * Fixes an issue that created duplicate copy data when copies or
387 volumes with parts were transferred.
388 * Fixes the Trim List feature in the Web staff client Check In screen.
389 * The Item Status grid now displays the Circulation Modifier.
390 * Restores missing data from the Profile column in Place Hold patron
392 * Fixes an issue with the http -> https redirect on Apache 2.4.
393 * Fixes an color contrast accessibility issue in the Web staff
394 client and adds underlining to links in grid cells for added accessibility.
395 * Adds automated regression and unit tests for the Web staff client
397 * Adds a process for spell-checking the official documentation.
398 * Adds a script that simplifies the release process related to translations.
403 We would like to thank the following individuals who contributed code,
404 tests and documentation patches to the 3.0.5 point release of
409 * Blake Graham-Henderson
424 This release contains bug fixes improving on Evergreen 3.0.3:
426 * Fixes a bug that caused all searches limited by shelving location to
428 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
429 rather than the ordering agency's SAN.
430 * Fixes a bug that prevented Safari/iOS users from logging in to the
432 * Fixes a bug that prevented users from using the browse interface.
433 * Fixes a bug in the Item Status List view that caused incorrect due
435 * Approval code is now a required field in the web client's patron
436 credit card payment form.
437 * Fixes a bug with credit card payments that caused a receipt to print
438 showing that the patron paid the bill when the payment had not actually
440 * Fixes a bug that prevented the EDI translator from being installed on
442 * Fixes a bug that caused entries to show up multiple times in the
443 Items Out and Holds tabs in the patron record.
444 * Fixes a bug that caused grids on Bills and Patron Messages
445 screens to not display properly.
446 * The following fields are now available for the Checkout and Items Out
453 ** money_summary.balance_owed
454 ** money_summary.total_paid
455 ** money_summary.total_owed
460 * The following fields are now available on the Bill Payment receipt templates:
470 * Payment type is now a column in the payments tab of the patron record
471 Bill History section.
472 * The "Replace Barcode" function now makes it more difficult for staff
473 members to attempt to create blank patron barcodes.
474 * The patron bills screen now prevents staff members from double-clicking
475 on the Apply Payment button (which otherwise would apply two payments).
476 * Fixes a bug that prevented patrons attached to statistical categories
477 from displaying in the patron search-to-hold dialog.
478 * Fixes a performance issue related to uploading CSV files of barcodes
479 to the item status and patron bucket interfaces.
480 * Fixes several small bugs in the Spanish translation.
481 * Fixes a performance bug related to patrons logging in by barcode.
485 We would like to thank the following individuals who contributed code,
486 tests and documentation patches to the 3.0.4 point release of
508 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
509 update the visibility attributes of all bibs that make use of Located URIs or
510 bib sources. It may take a while to run on large datasets. If it it running
511 too long, it can be canceled and the following psql commands will create and
512 run a script that will perform the same action serially over time without
513 blocking writes to bibs:
516 \o /tmp/luri_visibility_update.sql
517 SELECT 'UPDATE biblio.record_entry SET ' ||
518 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
519 'WHERE id = ' || id || '; SELECT ' || id || ';'
520 FROM biblio.record_entry
522 SELECT DISTINCT cn.record
523 FROM asset.call_number cn
525 AND cn.label = '##URI##'
528 FROM asset.uri_call_number_map m
529 WHERE m.call_number = cn.id
532 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
537 \i /tmp/luri_visibility_update.sql
540 It will output the id of each updated bib so that the script can be killed
541 and then edited to remove completed bibs. The remainder can be run at a
544 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
545 we do NOT update the bib's visibility attributes, as doing so causes a loop
546 and an eventual trigger stack violation. This flag should ONLY be used when
547 forcing reingest of record attributes (NOT visibility attributes), search,
548 facet, and display fields, so if using this flag under normal operation,
549 proceed at your own risk and know that Located URI and bib source changes
550 will not be reflected in the visibility attributes of the record.
554 This release contains several bug fixes improving on Evergreen 3.0.1:
556 * Fixes several issues related to the display of located URIs and records with
557 bib sources in search results.
558 * Setting `opac_visible` to false for a copy location group now hides only
559 the location group itself, rather than also hiding every single copy in the
561 * Fixes a bug that prevented the copy editor from displaying the _fine level_
562 and _loan duration_ fields.
563 * The "Edit Items" grid action in the Item Status interface will now open
564 in the combined volume/copy editor in batch. This makes the behavior
565 consistent with the "Edit Selected Items" grid action in the copy
567 * Staff members are now required to choose a billing type when creating a
568 bill on a user account.
569 * The Web client now provides staff users with an alert and option to
570 override when an item with the Lost and Paid status is checked in.
571 * Fixes a bug where the Web client offline circ interface was not able
572 to set its working location.
573 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
575 * The MARC editor in the Web staff client now presents bib sources in
577 * Both circulation and grocery bills are now printed when a staff user selects
578 a patron account and clicks "Print Bills".
579 * Fixes an issue in the XUL serials interface the "Receive move/selected"
580 action from succeeding.
581 * Fixes a typo in the user password testing interface.
585 We would like to thank the following individuals who contributed code,
586 tests and documentation patches to the 3.0.3 point release of
605 This release contains several bug fixes improving on Evergreen 3.0.1:
607 * Copy templates created in XUL Holdings Maintenance will now be
608 automatically converted and displayed in the web staff client's
610 * The list of report templates now includes a column indicating whether
611 the template was originally created in the XUL staff client or the web
612 staff client; staff need to know this since report templates created in
613 one interface cannot be edited in the other.
614 * Call number prefixes and suffixes are now displayed in various grids
615 in the web staff client, including
616 ** Pending Copy Buckets
618 ** Checkin/Capture Holds
620 ** Patron Bills History
627 ** Bib Record View Holds
629 * Many patron fields have been redacted from the web staff client's patron
630 and record holds grids, leaving patron name, username, and ID.
631 * Fixes two bugs where patron records could fail to be saved upon editing.
632 * The web staff patron editor now better warns staff users about
633 duplicate names, IDs, phone numbers, and email addresses.
634 * Human readable labels are now displayed for certain fields in standing
636 * The patron summary in the web staff client now correctly displays
637 primary and secondary ID values.
638 * The web staff client's billing full details page now displays
639 information about the staff user that created a payment.
640 * The web staff client now requires staff users to explicitly set a
641 billing type when adding a manual bill.
642 * The web staff client's patron bill annotation modal now works.
643 * Patron barcode search completion in the web staff client now allows
644 the user to select from all of the matching patron records.
645 * The Hold Shelf Slip print template in the web staff client now has
646 access to the call number.
647 * The Checkout Receipt print template in the web staff client now can
648 include summary financial information, incuding current balance, total
649 paid on outstanding fines, and total owed.
650 * The web staff print templates for current and historical bills can
651 now include copy barcode and title.
652 * Fixes a bug that resulted in some catalog searches unexpectedly
654 * Fixes a bug that resulted in catalog searches that specify a location
655 limit returning incorrect results.
656 * Fixes a bug where deleted copies could make records visible in the
658 * Fixes a bug where certain queries on copies used in the public catalog
660 * Fixes a bug place a hold request in the public catalog could result
661 in "forgetting" the type and library of the user's previous search.
662 * The web staff client now respects staff user session timeouts, and
663 will log out all open tabs if a user's session has timed out.
664 * The web staff Z39.50 page will now give the staff user an alert if
665 they attempt to import a record with a duplicate TCN.
666 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
667 entries from being deleted.
668 * Fixes a bug that made using the volume/copy editor to change a copy's
670 * The administration interface for hard due dates now ensures that
671 new (or edited) ceiling dates have their time component set to end
672 of day, resolving an issue where ceiling dates would not be applied
673 during the ceiling date itself.
674 * The web staff client can now include dynamic information in browser
675 tab titles, e.g., "Smith, Jane - Checkout".
676 * The Concerto sample data set now includes data allowing for testing
677 placing holds on monographic parts.
678 * Asset merging during bibliographic record merging now correctly
679 recognizes call number prefixes and suffixes and deletes disused
681 * Fixes a bug where displaying user surveys could result in PCRUD
683 * Fixes a bug where pg_restore of an Evergreen database could fail
684 to create certain indexes on the `actor.usr` table.
688 We would like to thank the following individuals who contributed code,
689 tests and documentation patches to the 3.0.2 point release of
720 This release contains several bug fixes improving on Evergreen 3.0.0
722 * Fixes a bug in the web staff client that prevented initials from being
723 stored with copy notes.
724 * Adds billing types that may have been missed by systems that were
725 running Evergreen prior to the 1.4 release.
726 * Fixes a web staff client bug with the CSV export option available from
727 the Import Queue in the MARC Batch Import/Export interface.
728 * Adds the missing copy alert field in the web client's volume/copy
730 * Fixes a bug where the setting to require date of birth in patron
731 registration was not being honored in the web staff client.
732 * Fixes a bug in the web staff client patron registration form where the
733 password wasn't generating from the last four digits of the patron's
735 * Fixes an issue in the web staff client where the complete barcode did
736 not display in some interfaces when partial barcodes were scanned.
737 * Fixes an HTML error in the new copy tags that display on the record
739 * Fixes a web staff client bug where recording a large number of in-house
740 uses at one time doesn't display a confirmation dialog once it hits the
742 * Adds a _Print Full Grid_ action in the web staff client
743 holds pull list to allow staff to print the entire pull list as it
744 displays on the screen. This change also changes the _Export CSV_ action
745 to an _Export Full CSV_ option.
746 * Fixes an issue with the Patron Messages interface that prevented it
747 from saving column configuration changes in the web staff client.
748 * Fixes a bug in the web staff client where a billing prompt did not
749 correctly display after marking an item damaged in those systems that
750 have enabled the setting to bill for damaged items.
751 * Adds an option to the specific due date feature that allows saving
752 that due date until logout. This allows all circulations from a given
753 workstation to be due on the same date.
757 We would like to thank the following individuals who contributed code,
758 tests and documentation patches to the 3.0.1 point release of
780 The minimum version of PostgreSQL required to run Evergreen 3.0 is
781 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
783 Change to Names of Shared Libraries
784 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
785 OpenSRF 3.0 changes how the shared libraries for services written in
786 C are named. If upgrading from an earlier version of Evergreen,
787 `opensrf.xml` should be edited so that shared library file names
788 listed in the `<implementation>` tag start with "lib". For example,
791 ---------------------------------------------------------------------
793 <language>C</language>
794 <implementation>oils_cstore.so</implementation>
795 ---------------------------------------------------------------------
797 should be changed to:
800 ---------------------------------------------------------------------
802 <language>C</language>
803 <implementation>liboils_cstore.so</implementation>
804 ---------------------------------------------------------------------
806 SIP Bugfix Requires SIPServer Upgrade
807 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
809 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
810 crash" requires that you also upgrade SIPServer with the fix for
811 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
812 SIP client problems." This means that if you use SIP2 with Evergreen,
813 you must also upgrade SIPServer to the latest commit in the Git
814 repository. Conversely, if you upgrade SIPServer to the latest commit
815 in Git, you must also upgrade Evergreen or, at least, apply the patch
816 for Launchpad Bug 1542495. These two patches are complementary and
817 cannot be applied independently of one another.
819 `open-ils.auth.login`
820 ~~~~~~~~~~~~~~~~~~~~~
821 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
822 API's in the `opensrf_core.xml` file.
827 ---------------------------------------------------------------------
828 --- a/Open-ILS/examples/opensrf_core.xml.example
829 +++ b/Open-ILS/examples/opensrf_core.xml.example
830 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
832 <match_string>open-ils.auth.authenticate.verify</match_string>
833 <match_string>open-ils.auth.authenticate.complete</match_string>
834 + <match_string>open-ils.auth.login</match_string>
835 <match_string>open-ils.auth_proxy.login</match_string>
836 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
837 <match_string>open-ils.actor.user.password</match_string>
838 ---------------------------------------------------------------------
842 Administrators of Evergreen who use RTL locales and who have customized
843 `style-rtl.css.tt2` should now incorporate their customizations into
846 Multi-Time Zone Installations
847 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
849 For Evergreen consortia that span more than one time zone, the following
850 query will adjust all historical, unaged circulations so
851 that if their due date field is pushed to the end of the day, it is done
852 in the circulating library's time zone, and not the server time zone.
854 It is safe to run this after any change to library time zones.
856 Running this is not required, as no code before this change has
857 depended on the time string of '23:59:59'. It is also not necessary
858 if all of your libraries are in the same time zone, and that time zone
859 is the same as the database's configured time zone.
868 for ou_id in select id from actor.org_unit loop
869 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
870 if new_tz is not null then
871 update action.circulation
872 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
873 where circ_lib = ou_id
874 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
883 Deprecation of XUL staff client
884 -------------------------------
885 Starting with the release of 3.0.0, patches that fix XUL bugs will not
886 be merged into master or backported unless they meet one or more of
887 the following conditions:
889 a. the bug is a security issue
890 b. the bug involves the destruction of data
891 c. the bug is a regression of functionality in the XUL staff client
892 introduced by other work done to Evergreen
894 Under no circumstances will XUL staff client feature enhancements be merged.
896 This policy will continue through the 3.0.x and 3.1.x maintenance
897 release cycles, and will become moot upon the release of 3.2.0, when
898 the XUL staff client is slated to be entirely removed.
907 Evergreen 3.0 features a new, modern staff client that runs in the web browser
908 and can be used on desktop and mobile devices. All functional areas of the
909 system, including circulation, cataloging, acquisitions, serials, reports,
910 booking, administration, and offline circulation, are available in the new staff
911 client. Chrome and Firefox are officially supported for use with the web client.
913 Library staff will no longer need to download separate software to perform most
914 actions in Evergreen. A Chrome plugin called Hatch will be available as a
915 separate installation for workstations that require seamless, dialog-free
916 printing to multiple printers.
918 In addition to adding more portability and stability, the new staff client also
919 presents a cleaner and more modern interface for users. By virtue of running in
920 a browser, actions that users are accustomed to performing on other web sites
921 should now be available in the Evergreen client.
923 The old, XUL client will continue to be available to allow for a gradual
924 transition to the browser-based client, but no new features will be added. The
925 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
935 New EDI Order Generator
936 ^^^^^^^^^^^^^^^^^^^^^^^
941 . New database tables exist for configuring vendor-specific EDI order
945 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
948 ** Collection of `edi_attr`s. Each edi_account may be linked to one
950 ** One `edi_attr_set` per known vendor is added to the stock data, matching
951 the stock configuration found in the JEDI template.
952 * `acq.edi_attr_set_map`
953 ** Link between `edi_attr`s and `edi_attr_set`s.
955 . EDI Attribute Sets are manged via a new (browser client only) configuration
956 interface at 'Administration -> Acquisitions Administration -> EDI
959 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
960 is not set, default values will be used. Links between an EDI account
961 and an attribute set are managed in the EDI Accounts configuration
964 . Local modifications to the stock EG JEDI template are managed by modifying
965 and/or adding additional `edi_att_set`s as needed.
967 . A new `edi_order_pusher.pl` script is added which replaces the functionality
968 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
970 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
971 definition is no longer required and can be disabled.
976 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
977 specifies whether PO's generated via the account should be built using
978 EDI attributes or fall back to traditional JEDI A/T template generation.
980 This allows sites to activate EDI attributes on a per-account basis, making
981 it possible to migrate piecemeal to EDI attributes. For the initial roll
982 out of this new feature, no accounts will be configured to use EDI
983 attributes by default.
989 3 Day Courtesy Notice by SMS
990 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
991 New optional SMS text notification to be sent out 3 days prior to the due
992 date of any circulating item for patrons who have an SMS text number and
993 carrier stored in their accounts. This action trigger is disabled by default,
994 but can be enabled and modified by going into 'Administration -> Local Administration ->
995 Notifications / Action Triggers'.
997 You may wish to make use of granularity so that these messages are batched
998 and sent at the same time each day.
1003 Add Description Field to Circulation and Hold Configuration Entries
1004 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1005 The circulation and hold policy configuration rules now each have a
1006 description field. This allows administrators to add comments to
1007 describe the purpose of each rule.
1012 Apache Internal Port Configuration Option
1013 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1014 Apache configuration now supports a new variable which allows admins to
1015 specify the port used by Apache to handle HTTP traffic. The value is
1016 used for HTTP requests routed from Perl handlers back to the same Apache
1017 instance, like added content requests. Use this when running Apache
1018 with a non-standard port, typical with a proxy setup. Defaults to "80".
1021 -------------------------------------------------------------------
1024 PerlSetVar OILSWebInternalHTTPPort "7080"
1027 -------------------------------------------------------------------
1032 Configurable Bib Record Display Fields
1033 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1035 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1036 fields: 'Display Field?' and 'Display XPath'.
1038 When 'Display Field' is set to true, data from the field will be extracted
1039 from each record and added to a new table of display data for each bib
1042 If a value is present in the 'Display XPath' field, this XPath will be
1043 applied to the extracted data *after* the base XPath (from the 'XPath'
1044 field) is applied to each field.
1046 This data acts as a replacement for the various and sundry ways bib record
1047 data is currently extracted, including inline XPath in the TPAC, reporter
1048 views, real-time 'MVR' compilation from MODS, etc. and will be available
1049 to the user interface, notification templates, etc. for rendering bib
1052 The browser client gets a new service 'egBibDisplay' which is capable
1053 of translating the display field data from various formats into
1054 data more suitable for JavaScript usage.
1056 The database gets 3 new views for representing display data in various
1059 * `metabib.flat_display_entry`
1060 ** List of all display fields linked to their configuration.
1061 * `metabib.compressed_display_entry`
1062 ** Same as `metabib.flat_display_entry` except there's one row
1063 per display field type, with 'multi' rows compressed into
1064 JSON arrays. Non-multi fields are represented as JSON
1066 * `metabib.wide_display_entry`
1067 ** Tabular view of display field data, one column per well-known
1068 field. Values are represented JSON, consistent with
1069 `metabib.flat_display_entry`. The view does *not* contain locally
1070 configured display fields, as each field must be encoded in
1071 the view and IDL definition. This is essentially a replacement
1072 for `reporter.simple_record`.
1077 After making changes to display field configuration, it's possible to
1078 reingest only display field data in the database using the following:
1081 ---------------------------------------------------------------------
1082 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1083 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1084 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1085 ---------------------------------------------------------------------
1091 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1092 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1093 The existing permission was incorrectly created with a code of
1094 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1095 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1096 update changes the permission code to match what the event requires.
1102 Hold Targeter V2 Repairs and Improvements
1103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1104 * Make the batch targeter more resilient to a single-hold failure.
1105 * Additional batch targeter info logging.
1106 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1107 * Removes the confusingly named `--target-all` option
1108 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1109 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1111 New --next-check-interval Option
1112 ++++++++++++++++++++++++++++++++
1113 Specify how long after the current run time the targeter will retarget
1114 the currently affected holds. Applying a specific interval is useful
1115 when the retarget-interval is shorter than the time between targeter
1118 For example, if the targeter is run nightly at midnight with a
1119 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1120 since the holds won't be processed again until 48 hours later. This
1121 ensures that the org unit closed date checks are looking at the correct
1124 This setting overrides the default behavior of calculating the next
1125 retarget time from the retarget-interval.
1127 New --soft-retarget-interval Option
1128 +++++++++++++++++++++++++++++++++++
1129 This is a replacement for (and rebranding of) the `--skip-viable` option.
1130 The new option allows for time-based soft-targeting instead simple binary
1131 on/off soft-targeting.
1133 How soft-targeting works:
1135 * Update hold copy maps for all affected holds
1136 * Holds with viable targets (on the pull list) are otherwise left alone.
1137 * Holds without viable targets are retargeted in the usual manner.
1143 New marc_export --descendants Option
1144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1146 The `marc_export` script has a new option, `--descendants`. This option
1147 takes one argument of an organizational unit shortname. It works much
1148 like the existing `--library` option except that it is aware of the
1149 org. tree and will export records with holdings at the specified
1150 organizational unit and all of its descendants. This is handy if you
1151 want to export the records for all of the branches of a system. You
1152 can do that by specifying this option and the system's shortname,
1153 instead of specifying multiple `--library` options for each branch.
1155 The `--descendants` option can be repeated, as the `--library` option can.
1156 All of the specified org. units and their descendants will be included
1157 in the output. It can also be combined with individual `--library`
1158 options when necessary.
1163 RTL and LTR Public Catalog Stylesheets Merged
1164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1165 The RTL stylesheet for the public catalog,
1166 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1167 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1168 template will provide RTL or LTR styles based on the value of
1169 the `rtl` flag of the active locale. An `rtl` variable is also available
1170 in the template to allow the correct style to be chosen.
1175 Miscellaneous Improvements
1176 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1178 * If a filter is in effect in the Library Settings Editor,
1179 the filter will continue to be applied after a user
1180 changes the selected library.
1181 * Copy templates used for serials now correctly link to age
1182 protection rules and MARC item type values (for the
1183 "Circ as Type" field). During upgrade, the database update
1184 will set to NULL any age protection and circ as type fields
1185 in serial copy templates that do not point to defined values.
1190 Obsolete Internal Flag Removed
1191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1193 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1194 flag was removed from the `config.internal_flags` table. It was
1195 rendered obsolete by the addition of the 3 flags to control the
1196 browse, search, and facet indexing.
1201 Tweaks to Caching/Expiry of Public Catalog Assets
1202 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1203 The default cache expiration time for static assets (e.g.,
1204 CSS, image, and JavaScript files) in the public catalog and
1205 the Kid's PAC has been increased to one year. Links to all
1206 such assets now have a cache-busting value tacked on as a
1207 query parameter. This value is refreshed when `autogen.sh` is
1208 run, but it can also be manually set by adjusting the
1209 `ctx.cache_key` Template Toolkit variable.
1214 Action/Trigger Events Data Purging
1215 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1217 Action/Trigger event definitions have a new field called 'Retention
1218 Interval'. When an optional interval value is applied, events and
1219 template output data linked to the event definition will be deleted
1220 from the database once they reach the specified age.
1222 Retention Interval Restrictions for Passive Hooks
1223 +++++++++++++++++++++++++++++++++++++++++++++++++
1225 Restrictions are placed on retention interval values for event definitions
1226 using passive hooks to prevent data from being deleted while it's still
1227 needed by the system.
1229 The presence of event data is how the system knows not to send duplicate
1230 events. As long as a scenario exists where a duplicate event may be
1231 generated, the events must be retained.
1233 To apply a retention interval value to a passive-hook event definition:
1235 * The event definition must have a max_delay value.
1236 * The retention interval must be larger than the difference between
1237 the `delay` and `max_delay` values.
1239 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1240 interval must be greater than 3 days to ensure no duplicate events are
1241 created between the first event on day 7 and the end of the event validity
1247 A new `purge_at_events.sh` script is installed in the bin directory
1248 (typically `/openils/bin`) which should be added to CRON for regular
1251 NOTE: On large data sets, this script can take a long time to run and
1252 create higher than normal I/O load as it churns though the event and
1253 event_output tables. You may wish to run the script by hand the first
1254 time so it can be monitored. It can be run in psql like so:
1257 ---------------------------------------------------------------
1258 SELECT action_trigger.purge_events();
1259 ---------------------------------------------------------------
1261 NOTE: On *very* large data sets (10s to 100s of millions of event and
1262 event_output rows), it may be advisable to first repopulate the `event`
1263 and `event_output` tables with only the desired data before starting
1264 regular purges. This can be done, for example, using the copy to temp
1265 table, truncate source table, repopulate source table from temp table
1266 approach. This will be much faster than the `purge_events()` function
1267 in cases where most of the data will be purged.
1272 A number of `action_trigger.hook` entries which have always been treated
1273 as active hooks, though are configured as passive hooks, have been
1274 updated to properly reflect the non-passive-ness. This allows for
1275 simpler configuration of their retention interval values.
1281 Remove JSPAC Redirects
1282 ^^^^^^^^^^^^^^^^^^^^^^
1283 Future versions of Evergreen will no longer contain automatic redirects
1284 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1285 that the JSPAC is no longer supported. Existing sites, however, may
1286 wish to retain JSPAC redirects in their Apache configuration files since
1287 JSPAC URLs may still be used in the wild to access their catalogs.
1289 The original JSPAC URL redirects are all retained in the file
1290 `Open-ILS/examples/jspac_redirects.conf` for reference.
1300 New open-ils.auth.login API
1301 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1302 The `open-ils.auth` service has a new API for requesting an authentication
1303 token. It performs the same steps as the
1304 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1305 using the bare password. No intermediate password hashing is required.
1307 The paramaters are the same as the `.complete` call with a few modifications.
1309 1. Using the generic 'identifier' parameter in combination with the
1310 'org' parameter allows the API to reliably determine if an identifier
1311 value is a username or barcode. The caller is no longer required to
1312 make that determination up front.
1314 2. The 'nonce' parameter is no longer used.
1320 Batch Patron Contact Invalidation
1321 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1322 The following methods are used to mark patron contact fields
1323 as invalid by moving the invalid value to a standing penalty:
1325 * `open-ils.actor.invalidate.email`
1326 * `open-ils.actor.invalidate.day_phone`
1327 * `open-ils.actor.invalidate.evening_phone`
1328 * `open-ils.actor.invalidate.other_phone`
1330 These methods now accept a fifth argument specifying the value
1331 of the contact field, e.g., a specific phone number or email
1332 address. If supplied, and if a specific patron ID (the first
1333 argument) is not supplied, all patrons with that specific contact
1334 value will have it marked invalid.
1344 Pure-SQL catalog searching
1345 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1346 Public and staff catalog search is now both more accurate and faster
1347 by redesigning how the visibility of records is calculated.
1357 Authority Record and Headings Browse Improvements
1358 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1359 Various improvements are made to support for authority records
1360 and headings browsing:
1362 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1363 headings from authority records. Since the MODS and MADS stylesheets
1364 extract headings in similar ways, duplicate browse entries are now
1365 much less likely to occur.
1366 * A new configuration table, `authority.heading_field`, is now used
1367 to specify how headings should be extracted from authority records.
1368 * Related headings can now be identified as narrower or broader when
1369 browsing in the public catalog.
1370 * See references are now more reliably included in the browse list.
1371 * Scope (public) notes now display only under the main heading.
1372 * There is now a global flag, Display related headings (see-also) in browse,
1373 that can be used to control whether related headings (see-alsos) are
1374 displayed in the public catalog list.
1375 * A complete set of thesauruses are now included in the seed data. Thesauruses
1376 can now be identified using short and long codes.
1377 * The labels for see and see-also references in the public catalog are
1378 a bit more patron-friendly, and can now be tweaked via TPAC template
1379 customization in the browse.tt2 file.
1385 Copy Tags and Digital Bookplates
1386 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1387 Copy tags will allow staff to apply custom, pre-defined labels or tags
1388 to copies. Copy tags are searchable in both the staff client and public
1389 catalog. This feature was designed to be used for Digital Bookplates to
1390 attach donation or memorial information to copies, but may be used for
1391 broader purposes to tag items.
1393 Each copy tag can either be publicly-visible or visible only to staff.
1394 Copy tags also have types that can be used for restricting catalog
1395 searches on copy tags to particular types.
1397 Copy tags are displayed in the copy table in the record summary page in
1398 the public catalog, and a new library setting can be used to add
1399 a "Digital Bookplate" search field. Copy tags can also be used
1400 as a search filter, e.g.,
1402 * `copy_tag(bookplate, jane smith)`: search for records that have a
1403 copy tag of type 'bookplate' whose value contains 'jane smith'.
1404 * `copy_tag(*, jane smith)`: search for records that have a
1405 copy tag of any type whose value contains 'jane smith'.
1407 All staff-side interfaces related to copy tags exist only in the web
1408 staff client. There are two new administration interfaces for managing
1409 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1410 button for applying copy tags to copies; that interface can also be
1411 used to create new copy tags on the fly. Furthermore, the copy buckets
1412 interface now has an 'Apply Tags' action for assigning tags to groups
1418 Two new permission are included:
1420 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1421 'Administration -> Server Administration -> Copy Tag Types'
1422 * `ADMIN_COPY_TAG`: required to create a new tag under
1423 'Administration -> Local Administration -> Copy Tags'
1425 The existing permission `UPDATE_COPY` controls whether or not a user
1426 can link copies to tags.
1430 A new library setting, 'Enable Digital Bookplate Search', controls
1431 whether to display a 'Digital Bookplate' field in the search index
1432 drop-downs in the catalog. A 'Digital Bookplate' search will include
1433 all records that have a copy that matches the tag specified by the user.
1434 It should be noted that this library setting does not affect the
1435 display of copy tags on the catalog record summary page.
1440 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1441 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1442 The call number prefix and suffix, when present, are now included in
1443 subfields $k and $m of the 852 field when running `marc_export` with
1444 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1445 server configured to embed item data in 852 fields, the affixes are now
1446 included in subfields $k and $m.
1456 Batch Editing of Patron Records
1457 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1458 There is a now a new interface analogous to the Copy Bucket interface
1459 to select and group a set of users into a User Bucket.
1460 The addition of users to a User Bucket is possible from the Patron Search
1461 interface by the use of a new grid Action, and directly on the User Bucket
1462 interface by user barcode. It is also possible to add users to a User
1463 Bucket by uploading a text file that contains a list of user barcodes.
1465 From this interface it is possible to perform a set of specific batch update
1466 operations on user records.
1471 These fields can now be changed in batch via an action on the User Bucket
1472 grid if the staff user has the `UPDATE_USER` permission:
1475 * Primary Permission Group (group application permissions consulted)
1477 * Home Library (`UPDATE_USER` checked against both old and new value)
1478 * Privilege Expiration Date
1479 * Barred flag (`BAR_PATRON` permission consulted)
1480 * Internet Access Level
1482 Changes made in this interface can be rolled back.
1484 As a batch process, rather than a direct edit, this mechanism explicitly skips
1485 processing of Action/Trigger event definitions for user update.
1490 The batch edit mechanism also allows for the batch deletion of user. The staff
1491 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1493 Changes made in this interface can be rolled back.
1495 As a batch process, rather than a direct edit, this mechanism explicitly skips
1496 processing of Action/Trigger event definitions for user deletion.
1498 This mechanism does not use the Purge User functionality, but instead simply
1499 marks the users as deleted.
1501 Editing Statistical Category Entries
1502 ++++++++++++++++++++++++++++++++++++
1504 All users in the bucket can have their Statistical Category Entries
1505 modified. Unlike user data field updates, modification of Statistical
1506 Category Entries is permanent and cannot be rolled back.
1508 As a batch process, rather than a direct edit, this mechanism explicitly skips
1509 processing of Action/Trigger event definitions for user update.
1511 New Service Requirement
1512 +++++++++++++++++++++++
1514 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1515 unused in production. If this service has been removed from the configuration
1516 of a live Evergreen instances, it will need to be added back in order for
1517 batch user editing to succeed.
1522 Honor Timezone of the Acting Library
1523 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1528 * Display day-granular due dates in the circulating library's timezone.
1529 * Only display the date portion of the due date for day-granular circulations.
1530 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1531 * Provide infrastructure for more advanced formatting of timestamps.
1532 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1537 This is a followup to the work done for 2.12, where we added the ability
1538 for the client to specify a timezone in which timestamps should be interpreted
1539 in business logic and the database.
1541 Most specifically, this work focuses on circulation due dates and the closed
1542 date editor. Due dates, where displayed using stock templates (including
1543 receipt templates) and used for fine calculation, are now manipulated in the
1544 library's configured timezone. This is controlled by the new 'lib.timezone'
1545 setting available via the Library Settings Editor, loaded from the server when
1546 required. Additionally, closings are recorded in the library's timezone so that
1547 due date calculation is more accurate. The closed date editor is also
1548 taught how to display closings in the
1549 closed library's timezone. Closed date entries also explicitly record if they
1550 are a full day closing, or a multi-day closing. This significantly simplifies
1551 the editor, and may be useful in other contexts.
1553 To accomplish this, we use the moment.js library and the moment-timezone addon.
1554 This is necessary because the stock AngularJS date filter does not understand
1555 locale-aware timezone values, which are required to support DST. A simple
1556 mapper translates the differences in format values from AngularJS date to
1559 Of special note are a set of new filters used for formatting timestamps under
1560 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1561 filters provide the functionality, and autogrid is enhanced to make use of
1562 these where applicable. egGrid and egGridField are also taught to accept
1563 default and field-specific options for applying date filters. These filters may
1564 be useful in other or related contexts.
1566 The egDueDate filter, used for all existing displays of due date via Angular
1567 code, intentionally interprets timestamps in two different ways WRT timezone,
1568 based on the circulation duration. If the duration is day-granular (that is,
1569 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1570 of seconds) then the date is interpreted as being in the circulation library's
1571 timezone. If it is an hourly loan (any duration that does not meet the
1572 day-granular criterium) then it is instead displayed in the client's timezone,
1573 just as all other timestamps currently are, because of the previous Evergreen
1576 The public catalog is adjusted to always display the due date in the circulating
1577 library's timezone. Because the public catalog displays only the date portion of the due
1578 date field, this difference is currently considered acceptable. If this proves
1579 to be a problem in the future, a minor adjustment can be made to match the
1580 egDueDate filter logic.
1582 Now that due dates are globally stored in the configured timezone of the
1583 circulating library, the automatic adjustment to day-granular due dates needs
1584 to take those timezones into account.
1586 An optional SQL command is provided by the upgrade script to retroactively
1587 adjust existing due dates after library configuration is complete.
1593 Enhancements to Hard Due Date Functionality
1594 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1595 It will now be possible to delete Hard Due Date Values for dates that have
1596 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1597 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1598 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1603 Patron Search by Birth Date
1604 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1605 * Now you can include the patron birth year and/or birth month and/or
1606 birth day when searching for patrons using the web staff client.
1607 * Day and month values are exact matches. E.g. month "1" (or "01")
1608 matches January, "12" matches December.
1609 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1610 1915, 1599, etc. For exact matches use the full 4-digit year.
1614 Patron Search from Place Hold
1615 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616 This feature allows staff members, when placing a
1617 hold on behalf of a patron in the web staff client, to search for
1618 patrons by names and other searchable patron information, rather than
1619 relying on barcode alone. In particular, after performing a catalog
1620 search or going to a specific bib record and clicking the 'Place Hold'
1621 button, the form now includes a 'Patron Search' button. This button
1622 will open a dialog allowing the staff member search for and select
1628 Retrieve Recent Patrons
1629 ^^^^^^^^^^^^^^^^^^^^^^^
1631 Adds a new library setting 'Number of Retrievable Recent Patrons'
1632 ('ui.staff.max_recent_patrons') that specifies the number of recently
1633 retrieved patrons that can be re-fetched from the staff client.
1635 A value of 0 means no recent patrons can be retrieved.
1636 A value greater than 1 means staff will be able to retrieve multiple
1637 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1639 The default value is 1 for backwards compatibility.
1646 Fuller title in XUL client Simplified Pull List
1647 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1648 The Simplified Pull List in the XUL client will now display subfields 245$n and
1649 $p in the title field. The addition will make it easier for staff to distinguish
1650 between different parts or seasons in a series.
1656 Transit Cancel Time and Terminology Change
1657 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1662 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1663 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1664 are preserved in the database, though still not visible to the end user in the staff client.
1665 This allows for better tracking of when transits are canceled for the purposes of knowing
1666 which staff member canceled the transit, etc.
1668 NOTE: This change may require the re-creation of transit reports to filter out canceled
1669 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1670 Is NULL' will suffice.
1672 "Canceled Transit" Terminology Change
1673 +++++++++++++++++++++++++++++++++++++
1675 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1676 For internal continuity, however, the following permission codes have not changed:
1679 * `ABORT_REMOTE_TRANSIT`
1680 * `ABORT_TRANSIT_ON_LOST`
1681 * `ABORT_TRANSIT_ON_MISSING`
1689 Offline Circulation Available in Web Staff Client
1690 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1691 Offline circulation is now available in the web staff client. In order to use the
1692 offline interface, users must first log into the web staff client, perform
1693 a patron search, select a user from the results, and open the patron editor
1694 interface to collect all the relevent configuration information for the
1695 workstation. In addition, the offline interface available from the Circulation
1696 menu provides a 'Download block list' button for users who are logged in.
1698 As is the case in the old staff client, users can check materials in and out,
1699 renew items, and create new patron accounts while offline. The patron fields
1700 available in the offline patron registration editor are the same ones that
1701 are available to staff when working online.
1705 Add Circ Modifier to Record Detail Page in Staff TPAC
1706 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1707 The circulation modifier field is added to the table of copies to make
1708 more information available to staff without having to open
1715 Date+Time Format Settings for Web Client
1716 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1718 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1719 and adds two settings for use with the webstaff client:
1721 * 'Format Dates with this pattern'
1722 * 'Format Date+Time with this pattern'
1724 These settings use format strings as documented here:
1726 https://docs.angularjs.org/api/ng/filter/date
1728 There is overlap with how the Dojo formats worked, but also some differences.
1730 The original 'Format Dates' and 'Format Times' settings worked together, but the
1731 new settings work independently. Certain field elements will use one, and
1732 certain field elements will use the other. These distinctions are hard-coded
1733 in the various UI templates, with the idea being that timestamp fields in
1734 which the date component alone is sufficient information (for example, date of birth)
1735 will use the 'Format Dates' setting. Fields where the time component is
1736 important (for example, checkout time) will use the 'Format Date+Time' setting.
1738 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1739 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1745 Global Option to Remove Sound for a Specific Event
1746 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1747 A new `nosound.wav` file has been added to the web client. The file can be used
1748 to globally disable audio alerts for a specific event on an Evergreen system.
1750 For example, to silence the alert that sounds after a successful patron search:
1754 mkdir -p /openils/var/web/audio/notifications/success/patron/
1755 cd /openils/var/web/audio/notifications/success/patron/
1756 ln -s ../../nosound.wav by_search.wav
1763 The official Evergreen manual has been split into eight new manuals, each
1764 designed for a specific audience. This new approach is designed to make
1765 the documentation more readable and usable.
1767 The specific audiences for the new manuals are:
1769 * Acquisitions staff
1772 * Public services staff who use the public catalog
1774 * System administrators who use the command line
1775 * System administrators who use the Web client
1776 * System administrators and programmers who wish to integrate Evergreen
1777 with other technologies
1779 All manuals are available at http://docs.evergreen-ils.org
1785 Improvements to ebook API
1786 ^^^^^^^^^^^^^^^^^^^^^^^^^
1788 Evergreen now supports checking out and placing holds on
1789 OverDrive and OneClickdigital ebook titles from within the public
1790 catalog. This is an experimental feature. It is not recommended for production
1791 use without careful testing.
1793 When ebook integration is enabled, a "Check Out E-Item" link will be
1794 displayed when viewing an ebook title from a supported vendor in the
1795 catalog. Clicking on the link allows the user to check out and download
1796 that title from the vendor directly within the catalog.
1798 If no copies are available for the title, a "Place Hold on E-Item" link
1799 is displayed instead, and the user may place a hold on the title. (Note
1800 that some vendors require the user's account to have an email address
1801 before permitting a hold.)
1803 My Account includes the ability to view current ebook checkouts and
1804 holds, download already-checked-out titles, and cancel holds.
1806 For API integration to work, you need to request API access from the
1807 vendor, and the vendor must have a way of authenticating your patrons.
1808 Your Evergreen system also needs to be configured for ebook API
1809 integration, following the instructions in the command line system
1810 administration manual
1813 This feature assumes that you are importing MARC records supplied by the
1814 vendor into your Evergreen system, using Vandelay or some other MARC
1815 import method. This feature does not search the vendor's online
1816 collections or automatically import vendor records into your system; it
1817 merely augments records that are already in Evergreen.
1819 Improvements to Bill Payment Pages
1820 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1821 The bill payment pages in the public catalog have been revamped
1824 * use the term "charges" instead of "fees"
1825 * include images of credit cards accepted
1826 * make the default print receipt template match other itemized receipts;
1827 note that this change is not automatically applied when upgrading.
1828 * display billing type
1829 * add button to pay only selected charges
1830 * reformat the credit card number input page
1836 Clickable Copy Locations
1837 ^^^^^^^^^^^^^^^^^^^^^^^^
1838 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1839 the associated copy location will display as a link in the public catalog summary display.
1840 This link can be useful for retrieving maps or other directions to the copy
1841 location to aid users in finding material.
1846 Download Checkout History CSV Fixed for Large Number of Circulations
1847 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1848 Downloading checkout history as a CSV from My Account has been fixed
1849 for users with a large circulation history. Previously, this would
1850 time out for patrons with more than 100 or so circulations.
1852 This feature no longer uses the action/trigger mechanism and the public catalog
1853 now generates the CSV directly. The old action/trigger code is still
1854 present in the database and should be removed at some point in the
1860 Google Books Preview Rewrite
1861 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1862 The Google Books Preview functionality in record detail pages has been
1863 rewritten to modernize its style and optimize its performance:
1865 * The Dojo JavaScript framework is no longer used, saving approximately
1866 150K of JavaScript and CSS and four network requests per page load.
1867 * The Embedded Viewer is not loaded unless a possible preview is found,
1868 saving more network and memory overhead.
1869 * The Google Books Loader is used to load the Embedded Viewer instead of the
1870 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1872 * All variables are self-contained and do not pollute the global namespace.
1873 * Event listeners are registered to handle clicks, rather than attaching
1874 `href="javascript:function()"` to <a> elements.
1875 * Book previews are displayed in a panel sized according to the viewport
1876 of the browser, improving its appearance on both mobile and desktop
1878 * The rewritten code is now served up directly from
1879 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1884 jQuery for the Public Catalog
1885 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1886 This release adds optional support for jQuery in the public catalog. This support
1887 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1888 `config.tt2` template.
1894 New Popularity Parameters
1895 ^^^^^^^^^^^^^^^^^^^^^^^^^
1896 New popularity parameters for in-house use over time and for count of distinct
1897 organizational units that own a title are now available. Evergreen sites
1898 can use these parameters to create new statistical popularity badges for
1899 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1901 The in-house use parameters will apply a badge to titles that have the most
1902 in-house use activity over time. The organizational unit count parameter
1903 will apply a badge to titles owned by the most number of libraries in a
1904 consortium. Ownership is determined by the copy's circulation library.
1909 Option to Suspend Holds at the Time They are Placed
1910 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1911 Users now have the option to suspend a hold at the same time they place the
1912 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1913 who want to suspend a hold at the time it is placed. There is also an option
1914 to set the activation date at the same time. This option is also available
1915 when placing holds on a batch of titles from 'My List' and will apply to
1916 all the titles in the batch.
1927 Fix to reporter.classic_current_circ View
1928 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1929 The `reporter.classic_current_circ` view, which is part of some
1930 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1931 has been fixed to not exclude loans for patrons who do not have a
1932 billing address set. Users of this view should rerun
1933 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1938 New Report Source Table Allowing Report of "Last" Deleted copy
1939 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1941 This source table allows you to construct a clever aggregate report template
1942 which will report bibliographic IDs where a library or a group of libraries
1943 no longer have a copy attached but *had* a copy attached. This is especially
1944 useful when a holdings sync is required with an external vendor.
1947 Instructions for creating a report template with this source:
1949 * Create a new report template using "Library Holdings Count with Deleted" as the source
1950 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1951 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1952 * 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"
1953 * Add "Bib ID" to Displayed Fields
1954 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1955 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1956 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1959 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1960 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1961 specified date range. Unfortunately the user will have to manually type the date range without the date
1962 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1963 copy and more than two deleted copies."
1968 Add Provider to Provider Note Link
1969 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1970 The Provider reporting source now includes a link to the Provider Note reporting source.
1975 Link ILS User and Working Location Reporting Sources
1976 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1977 The Working Location reporting source now has labels
1978 and it is now linked to the ILS User reporting source, allowing
1979 reports to display or filter on staff working location.
1984 New Circulation Report Source "All Circulation Combined Types"
1985 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1987 This report source will allow you to create a single report template for all of the following:
1990 * In-house uses of non-cataloged items
1992 * Circulations of non-cataloged items
1994 To distinguish between these different types of library use, it's important to display these columns
1995 in your report templates:
2004 Reports Template Searching
2005 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2006 A new form appears along the top of the reports interface for searching
2007 report templates. Once found, typical template actions (e.g. create new
2008 report) are available from within the results interface.
2010 Searches may be performed across selected (visible) folders or all
2011 folders visible to the logged in user.
2013 Searches are case-insensitive, any word order, with left-anchored words.
2014 All searched words must appear in at least one of the searched fields.
2019 * Searching for 'stat cat' matches:
2021 ** statistical category
2022 ** categories, statistical
2023 ** patrons (stat cat)
2024 * Searching for 'stat cat' does not match:
2026 *** both words must be present in the searched field(s)
2028 *** location contains 'cat' but it's not left-anchored.
2033 The templates, reports, and output interfaces now support paging via
2034 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2046 Web Staff Client Serials Module
2047 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2048 The serials module has been ported over to the web staff
2049 client, implementing a unified serials interface that combines
2050 ideas from both the serial control view and alternate serials
2051 control view from the old staff client.
2053 In addition to carrying over functionality that was available
2054 in the old staff client, several new features are included:
2056 * the ability to save prediction pattern codes as templates
2057 that can be shared and reused within an Evergreen database
2058 * a more streamlined interface for managing subscriptions,
2059 distributions, and streams
2060 * it is no longer necessary to create a starting issue in
2061 order to predict a run of issues; the dialog box for
2062 generating a set of predicted issues now lets you specify
2063 the starting point directly.
2064 * the ability to more directly edit MFHDs
2066 The new serials interfaces can be accessed from the record
2067 details page via a Serials drop-down button that links to
2068 a subscription management page, a quick-receive action, and
2069 a MFHD management page. There is also a new 'Serials Administration'
2070 page where prediction pattern and serial copy templates can
2081 SIP Bugfix Changes How Encoding Is Determined in Configuration
2082 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2084 The combined fix for the above mentioned SIP bugs alters the way that
2085 SIPServer looks up the output encoding in the configuration file (typically
2086 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2089 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2090 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2091 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.
2092 4. If none of the above exist, then the default encoding (ASCII) is used.
2094 Number 3 is provided to ease the transition to the new code. It is
2095 the current location of the +encoding+ element in the sample
2096 configuration file and as such, where it is likely to be found in
2097 actual files. It is recommended that you alter your configuration to
2098 move this element out of the +implementation_config+ element and into
2099 its parent +institution+ element. Ideally, SIPServer should *not* look into
2100 the implementation config, and this check may be removed at some time
2108 Web Client Acknowledgments
2109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2111 The project to develop a new browser-based web client launched four
2112 years ago at the September 2013 Evergreen developer hack-a-way when the
2113 developer community voted to move away from the XUL client and explore other
2114 platforms. The first web client preview became available in Evergreen 2.7 when
2115 circulation was available in the new platform.
2117 The browser-based client is available due to the work of many coders, testers,
2118 bug reporters, documentors, translators, project managers, spec writers, funders
2119 and other contributors over the past four years.
2121 The Evergreen project would like to acknowledge the following organizations
2122 that funded development of the Web Staff Client:
2125 * British Columbia Libraries Cooperative
2126 * Consortium of Ohio Libraries
2128 * Georgia Public Library Service
2129 * Grand Rapids Public Library
2131 * Kenton County Public Library
2132 * King County Library System
2135 * Pennsylvania Integrated Library System
2136 * Pioneer Library System
2139 The Evergreen project would also like to thank the following individuals who
2140 contributed code, translations, documentation patches, tests, bug reports,
2141 technical specifications, and project management to the Web Staff Client:
2178 * Freddy Enrique Pelayo Huapalla
2204 Evergreen 3.0 Acknowledgments
2205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2207 The Evergreen project would like to acknowledge the following
2208 organizations that commissioned developments in this release of
2212 * British Columbia Libraries Cooperative (BC Sitka)
2214 * Georgia Public Library Service
2215 * King County Library System
2217 * Pennsylvania Integrated Library System
2218 * Pioneer Library System
2220 We would also like to thank the following individuals who contributed
2221 code, translations, documentation patches, and tests to this release of
2270 We also thank the following organizations whose employees contributed
2273 * British Columba Libraries Cooperative
2277 * Emerald Data Networks, Inc.
2278 * Equinox Open Library Initiative
2280 * Grand Rapids Public Library
2281 * Indiana State Library
2283 * King County Library System
2284 * Lake Agassiz Regional Library
2285 * Laurentian University
2286 * Linn-Benton Community College
2288 * Merrimack Valley Library Consortium
2290 * North of Boston Library Exchange
2291 * Pennsylvania Integrated Library System
2292 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2294 * Traverse Area District Library
2296 We regret any omissions. If a contributor has been inadvertently
2297 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob