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
294 * Corrects the "Holdable" attribute display on the Item Status detailed
296 * Fixes the ability to delete multiple copies from Item Status.
300 We would like to thank the following individuals who contributed code,
301 tests and documentation patches to the 3.0.7 point release of
315 This release is a security release that fixes cross-site scripting
316 (XSS) vulnerabilities in the Evergreen public catalog. This release
317 also includes several other bugfixes improving on Evergreen 3.0.5.
319 Security Issue: XSS Vulnerability in Public Catalog
320 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321 This release fixes several cross-site scripting (XSS) vulnerabilities
322 in the public catalog. When upgrading, Evergreen administrators should
323 review whether any of the following templates have been customized
324 or overridden. If so, either the template should be replaced with the
325 stock version or the XSS fix (which entails adding the `| html` filter
326 in several places) applied to the customized version.
328 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
329 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
330 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
332 Note that exploiting the XSS vulnerabilities fixed in this release
333 would require either the ability to create maliciously-constructed
334 MARC bibliographic or holdings records or the ability to set a
335 maliciously constructed organizational unit name.
339 Evergreen 3.0.6 also includes the following changes:
341 * When using 'Selection Lists -> Edit MARC Order Record' in the web
342 staff client, now only one click is required to save the MARC
343 record rather than two.
344 * The volume/copy editor in the web staff client now better handles
345 editing multiple items that have different sets of statistical
346 category values assigned to them.
347 * The act of merging bibliographic records now updates bookbags
348 that referred to the source bibliographic record rather than
349 effectively deleting entries for that record.
350 * Additional columns were added to the Holds Pull List in the
352 * The patron registration form in the web staff client now correctly
353 manages setting user preferences.
354 * An error in a pgTAP unit test was corrected.
358 We would like to thank the following individuals who contributed code,
359 tests and documentation patches to the 3.0.6 security release of
375 This release contains bug fixes improving on Evergreen 3.0.4.
377 * The MARC Editor in the Web staff client now wraps long fields.
378 * The MARC Editor no longer allows catalogers to enter new lines
380 * Fixes an issue that prevented serials items from being deleted or
382 * The Web staff client Check In screen no longer reloads the whole
383 page multiple times each time an item is scanned.
384 * Fixes an issue that displayed the oldest -- rather than the newest
385 -- transit in the Web staff client Item Status page.
386 * Fixes an issue that prevented the reports module from being displayed
388 * Fixes an issue in the Web staff client reports module that caused
389 syntax errors in reports that use virtual fields and joins.
390 * Fixes an issue that prevented several dropdown menus in the Web staff
391 client from activating.
392 * Fixes an issue that created duplicate copy data when copies or
393 volumes with parts were transferred.
394 * Fixes the Trim List feature in the Web staff client Check In screen.
395 * The Item Status grid now displays the Circulation Modifier.
396 * Restores missing data from the Profile column in Place Hold patron
398 * Fixes an issue with the http -> https redirect on Apache 2.4.
399 * Fixes an color contrast accessibility issue in the Web staff
400 client and adds underlining to links in grid cells for added accessibility.
401 * Adds automated regression and unit tests for the Web staff client
403 * Adds a process for spell-checking the official documentation.
404 * Adds a script that simplifies the release process related to translations.
409 We would like to thank the following individuals who contributed code,
410 tests and documentation patches to the 3.0.5 point release of
415 * Blake Graham-Henderson
430 This release contains bug fixes improving on Evergreen 3.0.3:
432 * Fixes a bug that caused all searches limited by shelving location to
434 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
435 rather than the ordering agency's SAN.
436 * Fixes a bug that prevented Safari/iOS users from logging in to the
438 * Fixes a bug that prevented users from using the browse interface.
439 * Fixes a bug in the Item Status List view that caused incorrect due
441 * Approval code is now a required field in the web client's patron
442 credit card payment form.
443 * Fixes a bug with credit card payments that caused a receipt to print
444 showing that the patron paid the bill when the payment had not actually
446 * Fixes a bug that prevented the EDI translator from being installed on
448 * Fixes a bug that caused entries to show up multiple times in the
449 Items Out and Holds tabs in the patron record.
450 * Fixes a bug that caused grids on Bills and Patron Messages
451 screens to not display properly.
452 * The following fields are now available for the Checkout and Items Out
459 ** money_summary.balance_owed
460 ** money_summary.total_paid
461 ** money_summary.total_owed
466 * The following fields are now available on the Bill Payment receipt templates:
476 * Payment type is now a column in the payments tab of the patron record
477 Bill History section.
478 * The "Replace Barcode" function now makes it more difficult for staff
479 members to attempt to create blank patron barcodes.
480 * The patron bills screen now prevents staff members from double-clicking
481 on the Apply Payment button (which otherwise would apply two payments).
482 * Fixes a bug that prevented patrons attached to statistical categories
483 from displaying in the patron search-to-hold dialog.
484 * Fixes a performance issue related to uploading CSV files of barcodes
485 to the item status and patron bucket interfaces.
486 * Fixes several small bugs in the Spanish translation.
487 * Fixes a performance bug related to patrons logging in by barcode.
491 We would like to thank the following individuals who contributed code,
492 tests and documentation patches to the 3.0.4 point release of
514 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
515 update the visibility attributes of all bibs that make use of Located URIs or
516 bib sources. It may take a while to run on large datasets. If it it running
517 too long, it can be canceled and the following psql commands will create and
518 run a script that will perform the same action serially over time without
519 blocking writes to bibs:
522 \o /tmp/luri_visibility_update.sql
523 SELECT 'UPDATE biblio.record_entry SET ' ||
524 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
525 'WHERE id = ' || id || '; SELECT ' || id || ';'
526 FROM biblio.record_entry
528 SELECT DISTINCT cn.record
529 FROM asset.call_number cn
531 AND cn.label = '##URI##'
534 FROM asset.uri_call_number_map m
535 WHERE m.call_number = cn.id
538 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
543 \i /tmp/luri_visibility_update.sql
546 It will output the id of each updated bib so that the script can be killed
547 and then edited to remove completed bibs. The remainder can be run at a
550 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
551 we do NOT update the bib's visibility attributes, as doing so causes a loop
552 and an eventual trigger stack violation. This flag should ONLY be used when
553 forcing reingest of record attributes (NOT visibility attributes), search,
554 facet, and display fields, so if using this flag under normal operation,
555 proceed at your own risk and know that Located URI and bib source changes
556 will not be reflected in the visibility attributes of the record.
560 This release contains several bug fixes improving on Evergreen 3.0.1:
562 * Fixes several issues related to the display of located URIs and records with
563 bib sources in search results.
564 * Setting `opac_visible` to false for a copy location group now hides only
565 the location group itself, rather than also hiding every single copy in the
567 * Fixes a bug that prevented the copy editor from displaying the _fine level_
568 and _loan duration_ fields.
569 * The "Edit Items" grid action in the Item Status interface will now open
570 in the combined volume/copy editor in batch. This makes the behavior
571 consistent with the "Edit Selected Items" grid action in the copy
573 * Staff members are now required to choose a billing type when creating a
574 bill on a user account.
575 * The Web client now provides staff users with an alert and option to
576 override when an item with the Lost and Paid status is checked in.
577 * Fixes a bug where the Web client offline circ interface was not able
578 to set its working location.
579 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
581 * The MARC editor in the Web staff client now presents bib sources in
583 * Both circulation and grocery bills are now printed when a staff user selects
584 a patron account and clicks "Print Bills".
585 * Fixes an issue in the XUL serials interface the "Receive move/selected"
586 action from succeeding.
587 * Fixes a typo in the user password testing interface.
591 We would like to thank the following individuals who contributed code,
592 tests and documentation patches to the 3.0.3 point release of
611 This release contains several bug fixes improving on Evergreen 3.0.1:
613 * Copy templates created in XUL Holdings Maintenance will now be
614 automatically converted and displayed in the web staff client's
616 * The list of report templates now includes a column indicating whether
617 the template was originally created in the XUL staff client or the web
618 staff client; staff need to know this since report templates created in
619 one interface cannot be edited in the other.
620 * Call number prefixes and suffixes are now displayed in various grids
621 in the web staff client, including
622 ** Pending Copy Buckets
624 ** Checkin/Capture Holds
626 ** Patron Bills History
633 ** Bib Record View Holds
635 * Many patron fields have been redacted from the web staff client's patron
636 and record holds grids, leaving patron name, username, and ID.
637 * Fixes two bugs where patron records could fail to be saved upon editing.
638 * The web staff patron editor now better warns staff users about
639 duplicate names, IDs, phone numbers, and email addresses.
640 * Human readable labels are now displayed for certain fields in standing
642 * The patron summary in the web staff client now correctly displays
643 primary and secondary ID values.
644 * The web staff client's billing full details page now displays
645 information about the staff user that created a payment.
646 * The web staff client now requires staff users to explicitly set a
647 billing type when adding a manual bill.
648 * The web staff client's patron bill annotation modal now works.
649 * Patron barcode search completion in the web staff client now allows
650 the user to select from all of the matching patron records.
651 * The Hold Shelf Slip print template in the web staff client now has
652 access to the call number.
653 * The Checkout Receipt print template in the web staff client now can
654 include summary financial information, incuding current balance, total
655 paid on outstanding fines, and total owed.
656 * The web staff print templates for current and historical bills can
657 now include copy barcode and title.
658 * Fixes a bug that resulted in some catalog searches unexpectedly
660 * Fixes a bug that resulted in catalog searches that specify a location
661 limit returning incorrect results.
662 * Fixes a bug where deleted copies could make records visible in the
664 * Fixes a bug where certain queries on copies used in the public catalog
666 * Fixes a bug place a hold request in the public catalog could result
667 in "forgetting" the type and library of the user's previous search.
668 * The web staff client now respects staff user session timeouts, and
669 will log out all open tabs if a user's session has timed out.
670 * The web staff Z39.50 page will now give the staff user an alert if
671 they attempt to import a record with a duplicate TCN.
672 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
673 entries from being deleted.
674 * Fixes a bug that made using the volume/copy editor to change a copy's
676 * The administration interface for hard due dates now ensures that
677 new (or edited) ceiling dates have their time component set to end
678 of day, resolving an issue where ceiling dates would not be applied
679 during the ceiling date itself.
680 * The web staff client can now include dynamic information in browser
681 tab titles, e.g., "Smith, Jane - Checkout".
682 * The Concerto sample data set now includes data allowing for testing
683 placing holds on monographic parts.
684 * Asset merging during bibliographic record merging now correctly
685 recognizes call number prefixes and suffixes and deletes disused
687 * Fixes a bug where displaying user surveys could result in PCRUD
689 * Fixes a bug where pg_restore of an Evergreen database could fail
690 to create certain indexes on the `actor.usr` table.
694 We would like to thank the following individuals who contributed code,
695 tests and documentation patches to the 3.0.2 point release of
726 This release contains several bug fixes improving on Evergreen 3.0.0
728 * Fixes a bug in the web staff client that prevented initials from being
729 stored with copy notes.
730 * Adds billing types that may have been missed by systems that were
731 running Evergreen prior to the 1.4 release.
732 * Fixes a web staff client bug with the CSV export option available from
733 the Import Queue in the MARC Batch Import/Export interface.
734 * Adds the missing copy alert field in the web client's volume/copy
736 * Fixes a bug where the setting to require date of birth in patron
737 registration was not being honored in the web staff client.
738 * Fixes a bug in the web staff client patron registration form where the
739 password wasn't generating from the last four digits of the patron's
741 * Fixes an issue in the web staff client where the complete barcode did
742 not display in some interfaces when partial barcodes were scanned.
743 * Fixes an HTML error in the new copy tags that display on the record
745 * Fixes a web staff client bug where recording a large number of in-house
746 uses at one time doesn't display a confirmation dialog once it hits the
748 * Adds a _Print Full Grid_ action in the web staff client
749 holds pull list to allow staff to print the entire pull list as it
750 displays on the screen. This change also changes the _Export CSV_ action
751 to an _Export Full CSV_ option.
752 * Fixes an issue with the Patron Messages interface that prevented it
753 from saving column configuration changes in the web staff client.
754 * Fixes a bug in the web staff client where a billing prompt did not
755 correctly display after marking an item damaged in those systems that
756 have enabled the setting to bill for damaged items.
757 * Adds an option to the specific due date feature that allows saving
758 that due date until logout. This allows all circulations from a given
759 workstation to be due on the same date.
763 We would like to thank the following individuals who contributed code,
764 tests and documentation patches to the 3.0.1 point release of
786 The minimum version of PostgreSQL required to run Evergreen 3.0 is
787 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
789 Change to Names of Shared Libraries
790 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
791 OpenSRF 3.0 changes how the shared libraries for services written in
792 C are named. If upgrading from an earlier version of Evergreen,
793 `opensrf.xml` should be edited so that shared library file names
794 listed in the `<implementation>` tag start with "lib". For example,
797 ---------------------------------------------------------------------
799 <language>C</language>
800 <implementation>oils_cstore.so</implementation>
801 ---------------------------------------------------------------------
803 should be changed to:
806 ---------------------------------------------------------------------
808 <language>C</language>
809 <implementation>liboils_cstore.so</implementation>
810 ---------------------------------------------------------------------
812 SIP Bugfix Requires SIPServer Upgrade
813 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
815 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
816 crash" requires that you also upgrade SIPServer with the fix for
817 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
818 SIP client problems." This means that if you use SIP2 with Evergreen,
819 you must also upgrade SIPServer to the latest commit in the Git
820 repository. Conversely, if you upgrade SIPServer to the latest commit
821 in Git, you must also upgrade Evergreen or, at least, apply the patch
822 for Launchpad Bug 1542495. These two patches are complementary and
823 cannot be applied independently of one another.
825 `open-ils.auth.login`
826 ~~~~~~~~~~~~~~~~~~~~~
827 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
828 API's in the `opensrf_core.xml` file.
833 ---------------------------------------------------------------------
834 --- a/Open-ILS/examples/opensrf_core.xml.example
835 +++ b/Open-ILS/examples/opensrf_core.xml.example
836 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
838 <match_string>open-ils.auth.authenticate.verify</match_string>
839 <match_string>open-ils.auth.authenticate.complete</match_string>
840 + <match_string>open-ils.auth.login</match_string>
841 <match_string>open-ils.auth_proxy.login</match_string>
842 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
843 <match_string>open-ils.actor.user.password</match_string>
844 ---------------------------------------------------------------------
848 Administrators of Evergreen who use RTL locales and who have customized
849 `style-rtl.css.tt2` should now incorporate their customizations into
852 Multi-Time Zone Installations
853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
855 For Evergreen consortia that span more than one time zone, the following
856 query will adjust all historical, unaged circulations so
857 that if their due date field is pushed to the end of the day, it is done
858 in the circulating library's time zone, and not the server time zone.
860 It is safe to run this after any change to library time zones.
862 Running this is not required, as no code before this change has
863 depended on the time string of '23:59:59'. It is also not necessary
864 if all of your libraries are in the same time zone, and that time zone
865 is the same as the database's configured time zone.
874 for ou_id in select id from actor.org_unit loop
875 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
876 if new_tz is not null then
877 update action.circulation
878 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
879 where circ_lib = ou_id
880 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
889 Deprecation of XUL staff client
890 -------------------------------
891 Starting with the release of 3.0.0, patches that fix XUL bugs will not
892 be merged into master or backported unless they meet one or more of
893 the following conditions:
895 a. the bug is a security issue
896 b. the bug involves the destruction of data
897 c. the bug is a regression of functionality in the XUL staff client
898 introduced by other work done to Evergreen
900 Under no circumstances will XUL staff client feature enhancements be merged.
902 This policy will continue through the 3.0.x and 3.1.x maintenance
903 release cycles, and will become moot upon the release of 3.2.0, when
904 the XUL staff client is slated to be entirely removed.
913 Evergreen 3.0 features a new, modern staff client that runs in the web browser
914 and can be used on desktop and mobile devices. All functional areas of the
915 system, including circulation, cataloging, acquisitions, serials, reports,
916 booking, administration, and offline circulation, are available in the new staff
917 client. Chrome and Firefox are officially supported for use with the web client.
919 Library staff will no longer need to download separate software to perform most
920 actions in Evergreen. A Chrome plugin called Hatch will be available as a
921 separate installation for workstations that require seamless, dialog-free
922 printing to multiple printers.
924 In addition to adding more portability and stability, the new staff client also
925 presents a cleaner and more modern interface for users. By virtue of running in
926 a browser, actions that users are accustomed to performing on other web sites
927 should now be available in the Evergreen client.
929 The old, XUL client will continue to be available to allow for a gradual
930 transition to the browser-based client, but no new features will be added. The
931 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
941 New EDI Order Generator
942 ^^^^^^^^^^^^^^^^^^^^^^^
947 . New database tables exist for configuring vendor-specific EDI order
951 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
954 ** Collection of `edi_attr`s. Each edi_account may be linked to one
956 ** One `edi_attr_set` per known vendor is added to the stock data, matching
957 the stock configuration found in the JEDI template.
958 * `acq.edi_attr_set_map`
959 ** Link between `edi_attr`s and `edi_attr_set`s.
961 . EDI Attribute Sets are manged via a new (browser client only) configuration
962 interface at 'Administration -> Acquisitions Administration -> EDI
965 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
966 is not set, default values will be used. Links between an EDI account
967 and an attribute set are managed in the EDI Accounts configuration
970 . Local modifications to the stock EG JEDI template are managed by modifying
971 and/or adding additional `edi_att_set`s as needed.
973 . A new `edi_order_pusher.pl` script is added which replaces the functionality
974 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
976 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
977 definition is no longer required and can be disabled.
982 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
983 specifies whether PO's generated via the account should be built using
984 EDI attributes or fall back to traditional JEDI A/T template generation.
986 This allows sites to activate EDI attributes on a per-account basis, making
987 it possible to migrate piecemeal to EDI attributes. For the initial roll
988 out of this new feature, no accounts will be configured to use EDI
989 attributes by default.
995 3 Day Courtesy Notice by SMS
996 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
997 New optional SMS text notification to be sent out 3 days prior to the due
998 date of any circulating item for patrons who have an SMS text number and
999 carrier stored in their accounts. This action trigger is disabled by default,
1000 but can be enabled and modified by going into 'Administration -> Local Administration ->
1001 Notifications / Action Triggers'.
1003 You may wish to make use of granularity so that these messages are batched
1004 and sent at the same time each day.
1009 Add Description Field to Circulation and Hold Configuration Entries
1010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1011 The circulation and hold policy configuration rules now each have a
1012 description field. This allows administrators to add comments to
1013 describe the purpose of each rule.
1018 Apache Internal Port Configuration Option
1019 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1020 Apache configuration now supports a new variable which allows admins to
1021 specify the port used by Apache to handle HTTP traffic. The value is
1022 used for HTTP requests routed from Perl handlers back to the same Apache
1023 instance, like added content requests. Use this when running Apache
1024 with a non-standard port, typical with a proxy setup. Defaults to "80".
1027 -------------------------------------------------------------------
1030 PerlSetVar OILSWebInternalHTTPPort "7080"
1033 -------------------------------------------------------------------
1038 Configurable Bib Record Display Fields
1039 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1041 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1042 fields: 'Display Field?' and 'Display XPath'.
1044 When 'Display Field' is set to true, data from the field will be extracted
1045 from each record and added to a new table of display data for each bib
1048 If a value is present in the 'Display XPath' field, this XPath will be
1049 applied to the extracted data *after* the base XPath (from the 'XPath'
1050 field) is applied to each field.
1052 This data acts as a replacement for the various and sundry ways bib record
1053 data is currently extracted, including inline XPath in the TPAC, reporter
1054 views, real-time 'MVR' compilation from MODS, etc. and will be available
1055 to the user interface, notification templates, etc. for rendering bib
1058 The browser client gets a new service 'egBibDisplay' which is capable
1059 of translating the display field data from various formats into
1060 data more suitable for JavaScript usage.
1062 The database gets 3 new views for representing display data in various
1065 * `metabib.flat_display_entry`
1066 ** List of all display fields linked to their configuration.
1067 * `metabib.compressed_display_entry`
1068 ** Same as `metabib.flat_display_entry` except there's one row
1069 per display field type, with 'multi' rows compressed into
1070 JSON arrays. Non-multi fields are represented as JSON
1072 * `metabib.wide_display_entry`
1073 ** Tabular view of display field data, one column per well-known
1074 field. Values are represented JSON, consistent with
1075 `metabib.flat_display_entry`. The view does *not* contain locally
1076 configured display fields, as each field must be encoded in
1077 the view and IDL definition. This is essentially a replacement
1078 for `reporter.simple_record`.
1083 After making changes to display field configuration, it's possible to
1084 reingest only display field data in the database using the following:
1087 ---------------------------------------------------------------------
1088 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1089 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1090 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1091 ---------------------------------------------------------------------
1097 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1099 The existing permission was incorrectly created with a code of
1100 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1101 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1102 update changes the permission code to match what the event requires.
1108 Hold Targeter V2 Repairs and Improvements
1109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1110 * Make the batch targeter more resilient to a single-hold failure.
1111 * Additional batch targeter info logging.
1112 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1113 * Removes the confusingly named `--target-all` option
1114 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1115 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1117 New --next-check-interval Option
1118 ++++++++++++++++++++++++++++++++
1119 Specify how long after the current run time the targeter will retarget
1120 the currently affected holds. Applying a specific interval is useful
1121 when the retarget-interval is shorter than the time between targeter
1124 For example, if the targeter is run nightly at midnight with a
1125 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1126 since the holds won't be processed again until 48 hours later. This
1127 ensures that the org unit closed date checks are looking at the correct
1130 This setting overrides the default behavior of calculating the next
1131 retarget time from the retarget-interval.
1133 New --soft-retarget-interval Option
1134 +++++++++++++++++++++++++++++++++++
1135 This is a replacement for (and rebranding of) the `--skip-viable` option.
1136 The new option allows for time-based soft-targeting instead simple binary
1137 on/off soft-targeting.
1139 How soft-targeting works:
1141 * Update hold copy maps for all affected holds
1142 * Holds with viable targets (on the pull list) are otherwise left alone.
1143 * Holds without viable targets are retargeted in the usual manner.
1149 New marc_export --descendants Option
1150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1152 The `marc_export` script has a new option, `--descendants`. This option
1153 takes one argument of an organizational unit shortname. It works much
1154 like the existing `--library` option except that it is aware of the
1155 org. tree and will export records with holdings at the specified
1156 organizational unit and all of its descendants. This is handy if you
1157 want to export the records for all of the branches of a system. You
1158 can do that by specifying this option and the system's shortname,
1159 instead of specifying multiple `--library` options for each branch.
1161 The `--descendants` option can be repeated, as the `--library` option can.
1162 All of the specified org. units and their descendants will be included
1163 in the output. It can also be combined with individual `--library`
1164 options when necessary.
1169 RTL and LTR Public Catalog Stylesheets Merged
1170 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1171 The RTL stylesheet for the public catalog,
1172 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1173 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1174 template will provide RTL or LTR styles based on the value of
1175 the `rtl` flag of the active locale. An `rtl` variable is also available
1176 in the template to allow the correct style to be chosen.
1181 Miscellaneous Improvements
1182 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1184 * If a filter is in effect in the Library Settings Editor,
1185 the filter will continue to be applied after a user
1186 changes the selected library.
1187 * Copy templates used for serials now correctly link to age
1188 protection rules and MARC item type values (for the
1189 "Circ as Type" field). During upgrade, the database update
1190 will set to NULL any age protection and circ as type fields
1191 in serial copy templates that do not point to defined values.
1196 Obsolete Internal Flag Removed
1197 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1199 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1200 flag was removed from the `config.internal_flags` table. It was
1201 rendered obsolete by the addition of the 3 flags to control the
1202 browse, search, and facet indexing.
1207 Tweaks to Caching/Expiry of Public Catalog Assets
1208 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1209 The default cache expiration time for static assets (e.g.,
1210 CSS, image, and JavaScript files) in the public catalog and
1211 the Kid's PAC has been increased to one year. Links to all
1212 such assets now have a cache-busting value tacked on as a
1213 query parameter. This value is refreshed when `autogen.sh` is
1214 run, but it can also be manually set by adjusting the
1215 `ctx.cache_key` Template Toolkit variable.
1220 Action/Trigger Events Data Purging
1221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1223 Action/Trigger event definitions have a new field called 'Retention
1224 Interval'. When an optional interval value is applied, events and
1225 template output data linked to the event definition will be deleted
1226 from the database once they reach the specified age.
1228 Retention Interval Restrictions for Passive Hooks
1229 +++++++++++++++++++++++++++++++++++++++++++++++++
1231 Restrictions are placed on retention interval values for event definitions
1232 using passive hooks to prevent data from being deleted while it's still
1233 needed by the system.
1235 The presence of event data is how the system knows not to send duplicate
1236 events. As long as a scenario exists where a duplicate event may be
1237 generated, the events must be retained.
1239 To apply a retention interval value to a passive-hook event definition:
1241 * The event definition must have a max_delay value.
1242 * The retention interval must be larger than the difference between
1243 the `delay` and `max_delay` values.
1245 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1246 interval must be greater than 3 days to ensure no duplicate events are
1247 created between the first event on day 7 and the end of the event validity
1253 A new `purge_at_events.sh` script is installed in the bin directory
1254 (typically `/openils/bin`) which should be added to CRON for regular
1257 NOTE: On large data sets, this script can take a long time to run and
1258 create higher than normal I/O load as it churns though the event and
1259 event_output tables. You may wish to run the script by hand the first
1260 time so it can be monitored. It can be run in psql like so:
1263 ---------------------------------------------------------------
1264 SELECT action_trigger.purge_events();
1265 ---------------------------------------------------------------
1267 NOTE: On *very* large data sets (10s to 100s of millions of event and
1268 event_output rows), it may be advisable to first repopulate the `event`
1269 and `event_output` tables with only the desired data before starting
1270 regular purges. This can be done, for example, using the copy to temp
1271 table, truncate source table, repopulate source table from temp table
1272 approach. This will be much faster than the `purge_events()` function
1273 in cases where most of the data will be purged.
1278 A number of `action_trigger.hook` entries which have always been treated
1279 as active hooks, though are configured as passive hooks, have been
1280 updated to properly reflect the non-passive-ness. This allows for
1281 simpler configuration of their retention interval values.
1287 Remove JSPAC Redirects
1288 ^^^^^^^^^^^^^^^^^^^^^^
1289 Future versions of Evergreen will no longer contain automatic redirects
1290 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1291 that the JSPAC is no longer supported. Existing sites, however, may
1292 wish to retain JSPAC redirects in their Apache configuration files since
1293 JSPAC URLs may still be used in the wild to access their catalogs.
1295 The original JSPAC URL redirects are all retained in the file
1296 `Open-ILS/examples/jspac_redirects.conf` for reference.
1306 New open-ils.auth.login API
1307 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1308 The `open-ils.auth` service has a new API for requesting an authentication
1309 token. It performs the same steps as the
1310 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1311 using the bare password. No intermediate password hashing is required.
1313 The paramaters are the same as the `.complete` call with a few modifications.
1315 1. Using the generic 'identifier' parameter in combination with the
1316 'org' parameter allows the API to reliably determine if an identifier
1317 value is a username or barcode. The caller is no longer required to
1318 make that determination up front.
1320 2. The 'nonce' parameter is no longer used.
1326 Batch Patron Contact Invalidation
1327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1328 The following methods are used to mark patron contact fields
1329 as invalid by moving the invalid value to a standing penalty:
1331 * `open-ils.actor.invalidate.email`
1332 * `open-ils.actor.invalidate.day_phone`
1333 * `open-ils.actor.invalidate.evening_phone`
1334 * `open-ils.actor.invalidate.other_phone`
1336 These methods now accept a fifth argument specifying the value
1337 of the contact field, e.g., a specific phone number or email
1338 address. If supplied, and if a specific patron ID (the first
1339 argument) is not supplied, all patrons with that specific contact
1340 value will have it marked invalid.
1350 Pure-SQL catalog searching
1351 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1352 Public and staff catalog search is now both more accurate and faster
1353 by redesigning how the visibility of records is calculated.
1363 Authority Record and Headings Browse Improvements
1364 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1365 Various improvements are made to support for authority records
1366 and headings browsing:
1368 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1369 headings from authority records. Since the MODS and MADS stylesheets
1370 extract headings in similar ways, duplicate browse entries are now
1371 much less likely to occur.
1372 * A new configuration table, `authority.heading_field`, is now used
1373 to specify how headings should be extracted from authority records.
1374 * Related headings can now be identified as narrower or broader when
1375 browsing in the public catalog.
1376 * See references are now more reliably included in the browse list.
1377 * Scope (public) notes now display only under the main heading.
1378 * There is now a global flag, Display related headings (see-also) in browse,
1379 that can be used to control whether related headings (see-alsos) are
1380 displayed in the public catalog list.
1381 * A complete set of thesauruses are now included in the seed data. Thesauruses
1382 can now be identified using short and long codes.
1383 * The labels for see and see-also references in the public catalog are
1384 a bit more patron-friendly, and can now be tweaked via TPAC template
1385 customization in the browse.tt2 file.
1391 Copy Tags and Digital Bookplates
1392 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1393 Copy tags will allow staff to apply custom, pre-defined labels or tags
1394 to copies. Copy tags are searchable in both the staff client and public
1395 catalog. This feature was designed to be used for Digital Bookplates to
1396 attach donation or memorial information to copies, but may be used for
1397 broader purposes to tag items.
1399 Each copy tag can either be publicly-visible or visible only to staff.
1400 Copy tags also have types that can be used for restricting catalog
1401 searches on copy tags to particular types.
1403 Copy tags are displayed in the copy table in the record summary page in
1404 the public catalog, and a new library setting can be used to add
1405 a "Digital Bookplate" search field. Copy tags can also be used
1406 as a search filter, e.g.,
1408 * `copy_tag(bookplate, jane smith)`: search for records that have a
1409 copy tag of type 'bookplate' whose value contains 'jane smith'.
1410 * `copy_tag(*, jane smith)`: search for records that have a
1411 copy tag of any type whose value contains 'jane smith'.
1413 All staff-side interfaces related to copy tags exist only in the web
1414 staff client. There are two new administration interfaces for managing
1415 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1416 button for applying copy tags to copies; that interface can also be
1417 used to create new copy tags on the fly. Furthermore, the copy buckets
1418 interface now has an 'Apply Tags' action for assigning tags to groups
1424 Two new permission are included:
1426 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1427 'Administration -> Server Administration -> Copy Tag Types'
1428 * `ADMIN_COPY_TAG`: required to create a new tag under
1429 'Administration -> Local Administration -> Copy Tags'
1431 The existing permission `UPDATE_COPY` controls whether or not a user
1432 can link copies to tags.
1436 A new library setting, 'Enable Digital Bookplate Search', controls
1437 whether to display a 'Digital Bookplate' field in the search index
1438 drop-downs in the catalog. A 'Digital Bookplate' search will include
1439 all records that have a copy that matches the tag specified by the user.
1440 It should be noted that this library setting does not affect the
1441 display of copy tags on the catalog record summary page.
1446 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1447 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1448 The call number prefix and suffix, when present, are now included in
1449 subfields $k and $m of the 852 field when running `marc_export` with
1450 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1451 server configured to embed item data in 852 fields, the affixes are now
1452 included in subfields $k and $m.
1462 Batch Editing of Patron Records
1463 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1464 There is a now a new interface analogous to the Copy Bucket interface
1465 to select and group a set of users into a User Bucket.
1466 The addition of users to a User Bucket is possible from the Patron Search
1467 interface by the use of a new grid Action, and directly on the User Bucket
1468 interface by user barcode. It is also possible to add users to a User
1469 Bucket by uploading a text file that contains a list of user barcodes.
1471 From this interface it is possible to perform a set of specific batch update
1472 operations on user records.
1477 These fields can now be changed in batch via an action on the User Bucket
1478 grid if the staff user has the `UPDATE_USER` permission:
1481 * Primary Permission Group (group application permissions consulted)
1483 * Home Library (`UPDATE_USER` checked against both old and new value)
1484 * Privilege Expiration Date
1485 * Barred flag (`BAR_PATRON` permission consulted)
1486 * Internet Access Level
1488 Changes made in this interface can be rolled back.
1490 As a batch process, rather than a direct edit, this mechanism explicitly skips
1491 processing of Action/Trigger event definitions for user update.
1496 The batch edit mechanism also allows for the batch deletion of user. The staff
1497 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1499 Changes made in this interface can be rolled back.
1501 As a batch process, rather than a direct edit, this mechanism explicitly skips
1502 processing of Action/Trigger event definitions for user deletion.
1504 This mechanism does not use the Purge User functionality, but instead simply
1505 marks the users as deleted.
1507 Editing Statistical Category Entries
1508 ++++++++++++++++++++++++++++++++++++
1510 All users in the bucket can have their Statistical Category Entries
1511 modified. Unlike user data field updates, modification of Statistical
1512 Category Entries is permanent and cannot be rolled back.
1514 As a batch process, rather than a direct edit, this mechanism explicitly skips
1515 processing of Action/Trigger event definitions for user update.
1517 New Service Requirement
1518 +++++++++++++++++++++++
1520 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1521 unused in production. If this service has been removed from the configuration
1522 of a live Evergreen instances, it will need to be added back in order for
1523 batch user editing to succeed.
1528 Honor Timezone of the Acting Library
1529 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1534 * Display day-granular due dates in the circulating library's timezone.
1535 * Only display the date portion of the due date for day-granular circulations.
1536 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1537 * Provide infrastructure for more advanced formatting of timestamps.
1538 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1543 This is a followup to the work done for 2.12, where we added the ability
1544 for the client to specify a timezone in which timestamps should be interpreted
1545 in business logic and the database.
1547 Most specifically, this work focuses on circulation due dates and the closed
1548 date editor. Due dates, where displayed using stock templates (including
1549 receipt templates) and used for fine calculation, are now manipulated in the
1550 library's configured timezone. This is controlled by the new 'lib.timezone'
1551 setting available via the Library Settings Editor, loaded from the server when
1552 required. Additionally, closings are recorded in the library's timezone so that
1553 due date calculation is more accurate. The closed date editor is also
1554 taught how to display closings in the
1555 closed library's timezone. Closed date entries also explicitly record if they
1556 are a full day closing, or a multi-day closing. This significantly simplifies
1557 the editor, and may be useful in other contexts.
1559 To accomplish this, we use the moment.js library and the moment-timezone addon.
1560 This is necessary because the stock AngularJS date filter does not understand
1561 locale-aware timezone values, which are required to support DST. A simple
1562 mapper translates the differences in format values from AngularJS date to
1565 Of special note are a set of new filters used for formatting timestamps under
1566 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1567 filters provide the functionality, and autogrid is enhanced to make use of
1568 these where applicable. egGrid and egGridField are also taught to accept
1569 default and field-specific options for applying date filters. These filters may
1570 be useful in other or related contexts.
1572 The egDueDate filter, used for all existing displays of due date via Angular
1573 code, intentionally interprets timestamps in two different ways WRT timezone,
1574 based on the circulation duration. If the duration is day-granular (that is,
1575 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1576 of seconds) then the date is interpreted as being in the circulation library's
1577 timezone. If it is an hourly loan (any duration that does not meet the
1578 day-granular criterium) then it is instead displayed in the client's timezone,
1579 just as all other timestamps currently are, because of the previous Evergreen
1582 The public catalog is adjusted to always display the due date in the circulating
1583 library's timezone. Because the public catalog displays only the date portion of the due
1584 date field, this difference is currently considered acceptable. If this proves
1585 to be a problem in the future, a minor adjustment can be made to match the
1586 egDueDate filter logic.
1588 Now that due dates are globally stored in the configured timezone of the
1589 circulating library, the automatic adjustment to day-granular due dates needs
1590 to take those timezones into account.
1592 An optional SQL command is provided by the upgrade script to retroactively
1593 adjust existing due dates after library configuration is complete.
1599 Enhancements to Hard Due Date Functionality
1600 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1601 It will now be possible to delete Hard Due Date Values for dates that have
1602 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1603 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1604 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1609 Patron Search by Birth Date
1610 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1611 * Now you can include the patron birth year and/or birth month and/or
1612 birth day when searching for patrons using the web staff client.
1613 * Day and month values are exact matches. E.g. month "1" (or "01")
1614 matches January, "12" matches December.
1615 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1616 1915, 1599, etc. For exact matches use the full 4-digit year.
1620 Patron Search from Place Hold
1621 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1622 This feature allows staff members, when placing a
1623 hold on behalf of a patron in the web staff client, to search for
1624 patrons by names and other searchable patron information, rather than
1625 relying on barcode alone. In particular, after performing a catalog
1626 search or going to a specific bib record and clicking the 'Place Hold'
1627 button, the form now includes a 'Patron Search' button. This button
1628 will open a dialog allowing the staff member search for and select
1634 Retrieve Recent Patrons
1635 ^^^^^^^^^^^^^^^^^^^^^^^
1637 Adds a new library setting 'Number of Retrievable Recent Patrons'
1638 ('ui.staff.max_recent_patrons') that specifies the number of recently
1639 retrieved patrons that can be re-fetched from the staff client.
1641 A value of 0 means no recent patrons can be retrieved.
1642 A value greater than 1 means staff will be able to retrieve multiple
1643 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1645 The default value is 1 for backwards compatibility.
1652 Fuller title in XUL client Simplified Pull List
1653 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1654 The Simplified Pull List in the XUL client will now display subfields 245$n and
1655 $p in the title field. The addition will make it easier for staff to distinguish
1656 between different parts or seasons in a series.
1662 Transit Cancel Time and Terminology Change
1663 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1668 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1669 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1670 are preserved in the database, though still not visible to the end user in the staff client.
1671 This allows for better tracking of when transits are canceled for the purposes of knowing
1672 which staff member canceled the transit, etc.
1674 NOTE: This change may require the re-creation of transit reports to filter out canceled
1675 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1676 Is NULL' will suffice.
1678 "Canceled Transit" Terminology Change
1679 +++++++++++++++++++++++++++++++++++++
1681 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1682 For internal continuity, however, the following permission codes have not changed:
1685 * `ABORT_REMOTE_TRANSIT`
1686 * `ABORT_TRANSIT_ON_LOST`
1687 * `ABORT_TRANSIT_ON_MISSING`
1695 Offline Circulation Available in Web Staff Client
1696 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1697 Offline circulation is now available in the web staff client. In order to use the
1698 offline interface, users must first log into the web staff client, perform
1699 a patron search, select a user from the results, and open the patron editor
1700 interface to collect all the relevent configuration information for the
1701 workstation. In addition, the offline interface available from the Circulation
1702 menu provides a 'Download block list' button for users who are logged in.
1704 As is the case in the old staff client, users can check materials in and out,
1705 renew items, and create new patron accounts while offline. The patron fields
1706 available in the offline patron registration editor are the same ones that
1707 are available to staff when working online.
1711 Add Circ Modifier to Record Detail Page in Staff TPAC
1712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1713 The circulation modifier field is added to the table of copies to make
1714 more information available to staff without having to open
1721 Date+Time Format Settings for Web Client
1722 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1724 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1725 and adds two settings for use with the webstaff client:
1727 * 'Format Dates with this pattern'
1728 * 'Format Date+Time with this pattern'
1730 These settings use format strings as documented here:
1732 https://docs.angularjs.org/api/ng/filter/date
1734 There is overlap with how the Dojo formats worked, but also some differences.
1736 The original 'Format Dates' and 'Format Times' settings worked together, but the
1737 new settings work independently. Certain field elements will use one, and
1738 certain field elements will use the other. These distinctions are hard-coded
1739 in the various UI templates, with the idea being that timestamp fields in
1740 which the date component alone is sufficient information (for example, date of birth)
1741 will use the 'Format Dates' setting. Fields where the time component is
1742 important (for example, checkout time) will use the 'Format Date+Time' setting.
1744 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1745 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1751 Global Option to Remove Sound for a Specific Event
1752 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1753 A new `nosound.wav` file has been added to the web client. The file can be used
1754 to globally disable audio alerts for a specific event on an Evergreen system.
1756 For example, to silence the alert that sounds after a successful patron search:
1760 mkdir -p /openils/var/web/audio/notifications/success/patron/
1761 cd /openils/var/web/audio/notifications/success/patron/
1762 ln -s ../../nosound.wav by_search.wav
1769 The official Evergreen manual has been split into eight new manuals, each
1770 designed for a specific audience. This new approach is designed to make
1771 the documentation more readable and usable.
1773 The specific audiences for the new manuals are:
1775 * Acquisitions staff
1778 * Public services staff who use the public catalog
1780 * System administrators who use the command line
1781 * System administrators who use the Web client
1782 * System administrators and programmers who wish to integrate Evergreen
1783 with other technologies
1785 All manuals are available at http://docs.evergreen-ils.org
1791 Improvements to ebook API
1792 ^^^^^^^^^^^^^^^^^^^^^^^^^
1794 Evergreen now supports checking out and placing holds on
1795 OverDrive and OneClickdigital ebook titles from within the public
1796 catalog. This is an experimental feature. It is not recommended for production
1797 use without careful testing.
1799 When ebook integration is enabled, a "Check Out E-Item" link will be
1800 displayed when viewing an ebook title from a supported vendor in the
1801 catalog. Clicking on the link allows the user to check out and download
1802 that title from the vendor directly within the catalog.
1804 If no copies are available for the title, a "Place Hold on E-Item" link
1805 is displayed instead, and the user may place a hold on the title. (Note
1806 that some vendors require the user's account to have an email address
1807 before permitting a hold.)
1809 My Account includes the ability to view current ebook checkouts and
1810 holds, download already-checked-out titles, and cancel holds.
1812 For API integration to work, you need to request API access from the
1813 vendor, and the vendor must have a way of authenticating your patrons.
1814 Your Evergreen system also needs to be configured for ebook API
1815 integration, following the instructions in the command line system
1816 administration manual
1819 This feature assumes that you are importing MARC records supplied by the
1820 vendor into your Evergreen system, using Vandelay or some other MARC
1821 import method. This feature does not search the vendor's online
1822 collections or automatically import vendor records into your system; it
1823 merely augments records that are already in Evergreen.
1825 Improvements to Bill Payment Pages
1826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1827 The bill payment pages in the public catalog have been revamped
1830 * use the term "charges" instead of "fees"
1831 * include images of credit cards accepted
1832 * make the default print receipt template match other itemized receipts;
1833 note that this change is not automatically applied when upgrading.
1834 * display billing type
1835 * add button to pay only selected charges
1836 * reformat the credit card number input page
1842 Clickable Copy Locations
1843 ^^^^^^^^^^^^^^^^^^^^^^^^
1844 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1845 the associated copy location will display as a link in the public catalog summary display.
1846 This link can be useful for retrieving maps or other directions to the copy
1847 location to aid users in finding material.
1852 Download Checkout History CSV Fixed for Large Number of Circulations
1853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1854 Downloading checkout history as a CSV from My Account has been fixed
1855 for users with a large circulation history. Previously, this would
1856 time out for patrons with more than 100 or so circulations.
1858 This feature no longer uses the action/trigger mechanism and the public catalog
1859 now generates the CSV directly. The old action/trigger code is still
1860 present in the database and should be removed at some point in the
1866 Google Books Preview Rewrite
1867 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1868 The Google Books Preview functionality in record detail pages has been
1869 rewritten to modernize its style and optimize its performance:
1871 * The Dojo JavaScript framework is no longer used, saving approximately
1872 150K of JavaScript and CSS and four network requests per page load.
1873 * The Embedded Viewer is not loaded unless a possible preview is found,
1874 saving more network and memory overhead.
1875 * The Google Books Loader is used to load the Embedded Viewer instead of the
1876 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1878 * All variables are self-contained and do not pollute the global namespace.
1879 * Event listeners are registered to handle clicks, rather than attaching
1880 `href="javascript:function()"` to <a> elements.
1881 * Book previews are displayed in a panel sized according to the viewport
1882 of the browser, improving its appearance on both mobile and desktop
1884 * The rewritten code is now served up directly from
1885 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1890 jQuery for the Public Catalog
1891 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1892 This release adds optional support for jQuery in the public catalog. This support
1893 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1894 `config.tt2` template.
1900 New Popularity Parameters
1901 ^^^^^^^^^^^^^^^^^^^^^^^^^
1902 New popularity parameters for in-house use over time and for count of distinct
1903 organizational units that own a title are now available. Evergreen sites
1904 can use these parameters to create new statistical popularity badges for
1905 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1907 The in-house use parameters will apply a badge to titles that have the most
1908 in-house use activity over time. The organizational unit count parameter
1909 will apply a badge to titles owned by the most number of libraries in a
1910 consortium. Ownership is determined by the copy's circulation library.
1915 Option to Suspend Holds at the Time They are Placed
1916 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1917 Users now have the option to suspend a hold at the same time they place the
1918 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1919 who want to suspend a hold at the time it is placed. There is also an option
1920 to set the activation date at the same time. This option is also available
1921 when placing holds on a batch of titles from 'My List' and will apply to
1922 all the titles in the batch.
1933 Fix to reporter.classic_current_circ View
1934 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1935 The `reporter.classic_current_circ` view, which is part of some
1936 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1937 has been fixed to not exclude loans for patrons who do not have a
1938 billing address set. Users of this view should rerun
1939 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1944 New Report Source Table Allowing Report of "Last" Deleted copy
1945 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1947 This source table allows you to construct a clever aggregate report template
1948 which will report bibliographic IDs where a library or a group of libraries
1949 no longer have a copy attached but *had* a copy attached. This is especially
1950 useful when a holdings sync is required with an external vendor.
1953 Instructions for creating a report template with this source:
1955 * Create a new report template using "Library Holdings Count with Deleted" as the source
1956 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1957 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1958 * 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"
1959 * Add "Bib ID" to Displayed Fields
1960 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1961 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1962 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1965 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1966 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1967 specified date range. Unfortunately the user will have to manually type the date range without the date
1968 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1969 copy and more than two deleted copies."
1974 Add Provider to Provider Note Link
1975 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1976 The Provider reporting source now includes a link to the Provider Note reporting source.
1981 Link ILS User and Working Location Reporting Sources
1982 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1983 The Working Location reporting source now has labels
1984 and it is now linked to the ILS User reporting source, allowing
1985 reports to display or filter on staff working location.
1990 New Circulation Report Source "All Circulation Combined Types"
1991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1993 This report source will allow you to create a single report template for all of the following:
1996 * In-house uses of non-cataloged items
1998 * Circulations of non-cataloged items
2000 To distinguish between these different types of library use, it's important to display these columns
2001 in your report templates:
2010 Reports Template Searching
2011 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2012 A new form appears along the top of the reports interface for searching
2013 report templates. Once found, typical template actions (e.g. create new
2014 report) are available from within the results interface.
2016 Searches may be performed across selected (visible) folders or all
2017 folders visible to the logged in user.
2019 Searches are case-insensitive, any word order, with left-anchored words.
2020 All searched words must appear in at least one of the searched fields.
2025 * Searching for 'stat cat' matches:
2027 ** statistical category
2028 ** categories, statistical
2029 ** patrons (stat cat)
2030 * Searching for 'stat cat' does not match:
2032 *** both words must be present in the searched field(s)
2034 *** location contains 'cat' but it's not left-anchored.
2039 The templates, reports, and output interfaces now support paging via
2040 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2052 Web Staff Client Serials Module
2053 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2054 The serials module has been ported over to the web staff
2055 client, implementing a unified serials interface that combines
2056 ideas from both the serial control view and alternate serials
2057 control view from the old staff client.
2059 In addition to carrying over functionality that was available
2060 in the old staff client, several new features are included:
2062 * the ability to save prediction pattern codes as templates
2063 that can be shared and reused within an Evergreen database
2064 * a more streamlined interface for managing subscriptions,
2065 distributions, and streams
2066 * it is no longer necessary to create a starting issue in
2067 order to predict a run of issues; the dialog box for
2068 generating a set of predicted issues now lets you specify
2069 the starting point directly.
2070 * the ability to more directly edit MFHDs
2072 The new serials interfaces can be accessed from the record
2073 details page via a Serials drop-down button that links to
2074 a subscription management page, a quick-receive action, and
2075 a MFHD management page. There is also a new 'Serials Administration'
2076 page where prediction pattern and serial copy templates can
2087 SIP Bugfix Changes How Encoding Is Determined in Configuration
2088 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2090 The combined fix for the above mentioned SIP bugs alters the way that
2091 SIPServer looks up the output encoding in the configuration file (typically
2092 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2095 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2096 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2097 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.
2098 4. If none of the above exist, then the default encoding (ASCII) is used.
2100 Number 3 is provided to ease the transition to the new code. It is
2101 the current location of the +encoding+ element in the sample
2102 configuration file and as such, where it is likely to be found in
2103 actual files. It is recommended that you alter your configuration to
2104 move this element out of the +implementation_config+ element and into
2105 its parent +institution+ element. Ideally, SIPServer should *not* look into
2106 the implementation config, and this check may be removed at some time
2114 Web Client Acknowledgments
2115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2117 The project to develop a new browser-based web client launched four
2118 years ago at the September 2013 Evergreen developer hack-a-way when the
2119 developer community voted to move away from the XUL client and explore other
2120 platforms. The first web client preview became available in Evergreen 2.7 when
2121 circulation was available in the new platform.
2123 The browser-based client is available due to the work of many coders, testers,
2124 bug reporters, documentors, translators, project managers, spec writers, funders
2125 and other contributors over the past four years.
2127 The Evergreen project would like to acknowledge the following organizations
2128 that funded development of the Web Staff Client:
2131 * British Columbia Libraries Cooperative
2132 * Consortium of Ohio Libraries
2134 * Georgia Public Library Service
2135 * Grand Rapids Public Library
2137 * Kenton County Public Library
2138 * King County Library System
2141 * Pennsylvania Integrated Library System
2142 * Pioneer Library System
2145 The Evergreen project would also like to thank the following individuals who
2146 contributed code, translations, documentation patches, tests, bug reports,
2147 technical specifications, and project management to the Web Staff Client:
2184 * Freddy Enrique Pelayo Huapalla
2210 Evergreen 3.0 Acknowledgments
2211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2213 The Evergreen project would like to acknowledge the following
2214 organizations that commissioned developments in this release of
2218 * British Columbia Libraries Cooperative (BC Sitka)
2220 * Georgia Public Library Service
2221 * King County Library System
2223 * Pennsylvania Integrated Library System
2224 * Pioneer Library System
2226 We would also like to thank the following individuals who contributed
2227 code, translations, documentation patches, and tests to this release of
2276 We also thank the following organizations whose employees contributed
2279 * British Columba Libraries Cooperative
2283 * Emerald Data Networks, Inc.
2284 * Equinox Open Library Initiative
2286 * Grand Rapids Public Library
2287 * Indiana State Library
2289 * King County Library System
2290 * Lake Agassiz Regional Library
2291 * Laurentian University
2292 * Linn-Benton Community College
2294 * Merrimack Valley Library Consortium
2296 * North of Boston Library Exchange
2297 * Pennsylvania Integrated Library System
2298 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2300 * Traverse Area District Library
2302 We regret any omissions. If a contributor has been inadvertently
2303 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob