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