1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7. Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
17 * The MARC editor now handles 008 fields better.
18 * Adds spaces between subfields when suggesting a call
19 number for a new volume.
20 * MarcXML exports from the MARC Batch Import/Export ->
21 Export Records screen now downloads the file, rather than opening
23 * The Item Status Circulation Library column now displays a
24 shortname rather than the full library name.
25 * The Item Status Remaining Renewals column now displays
27 * The Item Status now has a "Last Renewal Workstation" column
29 * Fixes the circulation counts displayed in Item Status Details.
30 * Fixes an issue where multiple copies with different values for required
31 statistical categories could not be edited and saved in batch.
32 * Add an option to remove floating in the copy editor.
33 * Fixes an issue with the floating dropdown in the copy editor.
34 * Fixes a problem in which the copy template didn't properly copy
36 * Reduces the number of API calls that the MARC Editor requires.
41 * Fixes an issue that prevented the offline patron registration
43 * Fixes an issue with searching patrons by permission group.
44 * The barcodes in the patron search are now clickable.
45 * Staff members can now manually override the patron juvenile
46 flag value, regardless of the patron's date of birth.
47 * Checkboxes on patron registration screen are now properly aligned
49 * The user permission group dropdowns in the patron registration,
50 edit, and search interfaces now have scrollbars.
51 * The date picker on the checkout screen is now hidden unless
52 circ staff activates a specific due date option.
53 * The check-in screen now includes a copy status column.
54 * The Merge Patrons interface now displays the date of birth.
55 * The user bucket screen now displays the Bucket ID.
56 * The payment button on patron bills screen is now inactive if the
57 Payment Received field is blank.
58 * The Bill History receipt now includes a Finish date and a Last
60 * When a patron summary contains an image of the patron,
61 that image tag now has a null alt attribute to remove it from
62 the flow of a screen reader.
63 * Corrects an issue that caused the transit dialog to show the
65 * Corrects an issue with printing transit lists.
66 * "Find another target" on transiting hold no longer leaves the
68 * The images now display to distinguish hold and transit slips.
69 * The Clearable Holds list printout now only shows holds that have
71 * Restores the call number prefix and suffix fields to the holds
73 * The documentation at the top of the hold shelf slip template
75 * The cursor in the in-house use screen now automatically goes
77 * The in-house use screen now shows a copy status column.
78 * Add support for converting change to patron credit in the patron bills
79 interface, consistent with the XUL feature.
80 * Fixes a bug that caused pickup/request library fields to be
82 * Fixes a bug in the offline org unit tree.
84 Command-line system administration
85 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
87 * The novelist entry in `eg_vhost.conf` includes two new
89 * Corrects an issue with the `--max-sleep` argument on the
90 `action_trigger_runner.pl` support script.
91 * Corrects an issue with how the `eg_pbx_allocator.pl` script
92 detects an existing lock file.
93 * The 3.0.2-3.0.3 upgrade script disables triggers before
94 recalculating bib visibility.
99 * Fixes an issue that caused records with located URIs to be
100 retrieved in Copy Location and Copy Location Group searches.
101 * Fixes an error message that appeared in the search box
102 in the public catalog while placing hold after an advanced search.
103 * Restores the display of copy information for the user's
104 preferred library in the public catalog.
105 * Fixes regression errors in the search results page.
106 * Removes redundant call numbers from the Show More Details
108 * The cast field in the catalog is now taken from the 511 field
109 when first indicator = 1, rather than the 508.
110 * Fixes a display issue caused by editing holds.
115 * Fixes an issue that prevented users from searching for
116 receivable issues using Database ID or ISSN in the Serials
117 Batch Receive interface.
122 * Adds some padding to the bottom of Web Client interfaces.
123 * Logins now honor all org unit timeout settings.
124 * Evergreen will now identify and handle invalid timezones.
125 * Fixes an issue where a column header in some interfaces were automatically
126 highlighted in green when retrieving the interface.
127 * The parts column in the Item Status screen now displays parts data.
133 We would like to thank the following individuals who contributed code,
134 tests and documentation patches to the 3.0.8 point release of
169 This release contains bug fixes improving on Evergreen 3.0.6.
171 * Fixes a performance issue with the Patron Billing History screen and
172 other screens that cause Flattener.pm to re-create joins
174 * Fixes an issue that prevented patron alerts from showing to staff at
176 * Corrects the "Holdable" attribute display on the Item Status detailed
178 * Fixes the ability to delete multiple copies from Item Status.
182 We would like to thank the following individuals who contributed code,
183 tests and documentation patches to the 3.0.7 point release of
197 This release is a security release that fixes cross-site scripting
198 (XSS) vulnerabilities in the Evergreen public catalog. This release
199 also includes several other bugfixes improving on Evergreen 3.0.5.
201 Security Issue: XSS Vulnerability in Public Catalog
202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
203 This release fixes several cross-site scripting (XSS) vulnerabilities
204 in the public catalog. When upgrading, Evergreen administrators should
205 review whether any of the following templates have been customized
206 or overridden. If so, either the template should be replaced with the
207 stock version or the XSS fix (which entails adding the `| html` filter
208 in several places) applied to the customized version.
210 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
211 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
212 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
214 Note that exploiting the XSS vulnerabilities fixed in this release
215 would require either the ability to create maliciously-constructed
216 MARC bibliographic or holdings records or the ability to set a
217 maliciously constructed organizational unit name.
221 Evergreen 3.0.6 also includes the following changes:
223 * When using 'Selection Lists -> Edit MARC Order Record' in the web
224 staff client, now only one click is required to save the MARC
225 record rather than two.
226 * The volume/copy editor in the web staff client now better handles
227 editing multiple items that have different sets of statistical
228 category values assigned to them.
229 * The act of merging bibliographic records now updates bookbags
230 that referred to the source bibliographic record rather than
231 effectively deleting entries for that record.
232 * Additional columns were added to the Holds Pull List in the
234 * The patron registration form in the web staff client now correctly
235 manages setting user preferences.
236 * An error in a pgTAP unit test was corrected.
240 We would like to thank the following individuals who contributed code,
241 tests and documentation patches to the 3.0.6 security release of
257 This release contains bug fixes improving on Evergreen 3.0.4.
259 * The MARC Editor in the Web staff client now wraps long fields.
260 * The MARC Editor no longer allows catalogers to enter new lines
262 * Fixes an issue that prevented serials items from being deleted or
264 * The Web staff client Check In screen no longer reloads the whole
265 page multiple times each time an item is scanned.
266 * Fixes an issue that displayed the oldest -- rather than the newest
267 -- transit in the Web staff client Item Status page.
268 * Fixes an issue that prevented the reports module from being displayed
270 * Fixes an issue in the Web staff client reports module that caused
271 syntax errors in reports that use virtual fields and joins.
272 * Fixes an issue that prevented several dropdown menus in the Web staff
273 client from activating.
274 * Fixes an issue that created duplicate copy data when copies or
275 volumes with parts were transferred.
276 * Fixes the Trim List feature in the Web staff client Check In screen.
277 * The Item Status grid now displays the Circulation Modifier.
278 * Restores missing data from the Profile column in Place Hold patron
280 * Fixes an issue with the http -> https redirect on Apache 2.4.
281 * Fixes an color contrast accessibility issue in the Web staff
282 client and adds underlining to links in grid cells for added accessibility.
283 * Adds automated regression and unit tests for the Web staff client
285 * Adds a process for spell-checking the official documentation.
286 * Adds a script that simplifies the release process related to translations.
291 We would like to thank the following individuals who contributed code,
292 tests and documentation patches to the 3.0.5 point release of
297 * Blake Graham-Henderson
312 This release contains bug fixes improving on Evergreen 3.0.3:
314 * Fixes a bug that caused all searches limited by shelving location to
316 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
317 rather than the ordering agency's SAN.
318 * Fixes a bug that prevented Safari/iOS users from logging in to the
320 * Fixes a bug that prevented users from using the browse interface.
321 * Fixes a bug in the Item Status List view that caused incorrect due
323 * Approval code is now a required field in the web client's patron
324 credit card payment form.
325 * Fixes a bug with credit card payments that caused a receipt to print
326 showing that the patron paid the bill when the payment had not actually
328 * Fixes a bug that prevented the EDI translator from being installed on
330 * Fixes a bug that caused entries to show up multiple times in the
331 Items Out and Holds tabs in the patron record.
332 * Fixes a bug that caused grids on Bills and Patron Messages
333 screens to not display properly.
334 * The following fields are now available for the Checkout and Items Out
341 ** money_summary.balance_owed
342 ** money_summary.total_paid
343 ** money_summary.total_owed
348 * The following fields are now available on the Bill Payment receipt templates:
358 * Payment type is now a column in the payments tab of the patron record
359 Bill History section.
360 * The "Replace Barcode" function now makes it more difficult for staff
361 members to attempt to create blank patron barcodes.
362 * The patron bills screen now prevents staff members from double-clicking
363 on the Apply Payment button (which otherwise would apply two payments).
364 * Fixes a bug that prevented patrons attached to statistical categories
365 from displaying in the patron search-to-hold dialog.
366 * Fixes a performance issue related to uploading CSV files of barcodes
367 to the item status and patron bucket interfaces.
368 * Fixes several small bugs in the Spanish translation.
369 * Fixes a performance bug related to patrons logging in by barcode.
373 We would like to thank the following individuals who contributed code,
374 tests and documentation patches to the 3.0.4 point release of
396 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
397 update the visibility attributes of all bibs that make use of Located URIs or
398 bib sources. It may take a while to run on large datasets. If it it running
399 too long, it can be canceled and the following psql commands will create and
400 run a script that will perform the same action serially over time without
401 blocking writes to bibs:
404 \o /tmp/luri_visibility_update.sql
405 SELECT 'UPDATE biblio.record_entry SET ' ||
406 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
407 'WHERE id = ' || id || '; SELECT ' || id || ';'
408 FROM biblio.record_entry
410 SELECT DISTINCT cn.record
411 FROM asset.call_number cn
413 AND cn.label = '##URI##'
416 FROM asset.uri_call_number_map m
417 WHERE m.call_number = cn.id
420 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
425 \i /tmp/luri_visibility_update.sql
428 It will output the id of each updated bib so that the script can be killed
429 and then edited to remove completed bibs. The remainder can be run at a
432 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
433 we do NOT update the bib's visibility attributes, as doing so causes a loop
434 and an eventual trigger stack violation. This flag should ONLY be used when
435 forcing reingest of record attributes (NOT visibility attributes), search,
436 facet, and display fields, so if using this flag under normal operation,
437 proceed at your own risk and know that Located URI and bib source changes
438 will not be reflected in the visibility attributes of the record.
442 This release contains several bug fixes improving on Evergreen 3.0.1:
444 * Fixes several issues related to the display of located URIs and records with
445 bib sources in search results.
446 * Setting `opac_visible` to false for a copy location group now hides only
447 the location group itself, rather than also hiding every single copy in the
449 * Fixes a bug that prevented the copy editor from displaying the _fine level_
450 and _loan duration_ fields.
451 * The "Edit Items" grid action in the Item Status interface will now open
452 in the combined volume/copy editor in batch. This makes the behavior
453 consistent with the "Edit Selected Items" grid action in the copy
455 * Staff members are now required to choose a billing type when creating a
456 bill on a user account.
457 * The Web client now provides staff users with an alert and option to
458 override when an item with the Lost and Paid status is checked in.
459 * Fixes a bug where the Web client offline circ interface was not able
460 to set its working location.
461 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
463 * The MARC editor in the Web staff client now presents bib sources in
465 * Both circulation and grocery bills are now printed when a staff user selects
466 a patron account and clicks "Print Bills".
467 * Fixes an issue in the XUL serials interface the "Receive move/selected"
468 action from succeeding.
469 * Fixes a typo in the user password testing interface.
473 We would like to thank the following individuals who contributed code,
474 tests and documentation patches to the 3.0.3 point release of
493 This release contains several bug fixes improving on Evergreen 3.0.1:
495 * Copy templates created in XUL Holdings Maintenance will now be
496 automatically converted and displayed in the web staff client's
498 * The list of report templates now includes a column indicating whether
499 the template was originally created in the XUL staff client or the web
500 staff client; staff need to know this since report templates created in
501 one interface cannot be edited in the other.
502 * Call number prefixes and suffixes are now displayed in various grids
503 in the web staff client, including
504 ** Pending Copy Buckets
506 ** Checkin/Capture Holds
508 ** Patron Bills History
515 ** Bib Record View Holds
517 * Many patron fields have been redacted from the web staff client's patron
518 and record holds grids, leaving patron name, username, and ID.
519 * Fixes two bugs where patron records could fail to be saved upon editing.
520 * The web staff patron editor now better warns staff users about
521 duplicate names, IDs, phone numbers, and email addresses.
522 * Human readable labels are now displayed for certain fields in standing
524 * The patron summary in the web staff client now correctly displays
525 primary and secondary ID values.
526 * The web staff client's billing full details page now displays
527 information about the staff user that created a payment.
528 * The web staff client now requires staff users to explicitly set a
529 billing type when adding a manual bill.
530 * The web staff client's patron bill annotation modal now works.
531 * Patron barcode search completion in the web staff client now allows
532 the user to select from all of the matching patron records.
533 * The Hold Shelf Slip print template in the web staff client now has
534 access to the call number.
535 * The Checkout Receipt print template in the web staff client now can
536 include summary financial information, incuding current balance, total
537 paid on outstanding fines, and total owed.
538 * The web staff print templates for current and historical bills can
539 now include copy barcode and title.
540 * Fixes a bug that resulted in some catalog searches unexpectedly
542 * Fixes a bug that resulted in catalog searches that specify a location
543 limit returning incorrect results.
544 * Fixes a bug where deleted copies could make records visible in the
546 * Fixes a bug where certain queries on copies used in the public catalog
548 * Fixes a bug place a hold request in the public catalog could result
549 in "forgetting" the type and library of the user's previous search.
550 * The web staff client now respects staff user session timeouts, and
551 will log out all open tabs if a user's session has timed out.
552 * The web staff Z39.50 page will now give the staff user an alert if
553 they attempt to import a record with a duplicate TCN.
554 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
555 entries from being deleted.
556 * Fixes a bug that made using the volume/copy editor to change a copy's
558 * The administration interface for hard due dates now ensures that
559 new (or edited) ceiling dates have their time component set to end
560 of day, resolving an issue where ceiling dates would not be applied
561 during the ceiling date itself.
562 * The web staff client can now include dynamic information in browser
563 tab titles, e.g., "Smith, Jane - Checkout".
564 * The Concerto sample data set now includes data allowing for testing
565 placing holds on monographic parts.
566 * Asset merging during bibliographic record merging now correctly
567 recognizes call number prefixes and suffixes and deletes disused
569 * Fixes a bug where displaying user surveys could result in PCRUD
571 * Fixes a bug where pg_restore of an Evergreen database could fail
572 to create certain indexes on the `actor.usr` table.
576 We would like to thank the following individuals who contributed code,
577 tests and documentation patches to the 3.0.2 point release of
608 This release contains several bug fixes improving on Evergreen 3.0.0
610 * Fixes a bug in the web staff client that prevented initials from being
611 stored with copy notes.
612 * Adds billing types that may have been missed by systems that were
613 running Evergreen prior to the 1.4 release.
614 * Fixes a web staff client bug with the CSV export option available from
615 the Import Queue in the MARC Batch Import/Export interface.
616 * Adds the missing copy alert field in the web client's volume/copy
618 * Fixes a bug where the setting to require date of birth in patron
619 registration was not being honored in the web staff client.
620 * Fixes a bug in the web staff client patron registration form where the
621 password wasn't generating from the last four digits of the patron's
623 * Fixes an issue in the web staff client where the complete barcode did
624 not display in some interfaces when partial barcodes were scanned.
625 * Fixes an HTML error in the new copy tags that display on the record
627 * Fixes a web staff client bug where recording a large number of in-house
628 uses at one time doesn't display a confirmation dialog once it hits the
630 * Adds a _Print Full Grid_ action in the web staff client
631 holds pull list to allow staff to print the entire pull list as it
632 displays on the screen. This change also changes the _Export CSV_ action
633 to an _Export Full CSV_ option.
634 * Fixes an issue with the Patron Messages interface that prevented it
635 from saving column configuration changes in the web staff client.
636 * Fixes a bug in the web staff client where a billing prompt did not
637 correctly display after marking an item damaged in those systems that
638 have enabled the setting to bill for damaged items.
639 * Adds an option to the specific due date feature that allows saving
640 that due date until logout. This allows all circulations from a given
641 workstation to be due on the same date.
645 We would like to thank the following individuals who contributed code,
646 tests and documentation patches to the 3.0.1 point release of
668 The minimum version of PostgreSQL required to run Evergreen 3.0 is
669 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
671 Change to Names of Shared Libraries
672 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
673 OpenSRF 3.0 changes how the shared libraries for services written in
674 C are named. If upgrading from an earlier version of Evergreen,
675 `opensrf.xml` should be edited so that shared library file names
676 listed in the `<implementation>` tag start with "lib". For example,
679 ---------------------------------------------------------------------
681 <language>C</language>
682 <implementation>oils_cstore.so</implementation>
683 ---------------------------------------------------------------------
685 should be changed to:
688 ---------------------------------------------------------------------
690 <language>C</language>
691 <implementation>liboils_cstore.so</implementation>
692 ---------------------------------------------------------------------
694 SIP Bugfix Requires SIPServer Upgrade
695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
697 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
698 crash" requires that you also upgrade SIPServer with the fix for
699 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
700 SIP client problems." This means that if you use SIP2 with Evergreen,
701 you must also upgrade SIPServer to the latest commit in the Git
702 repository. Conversely, if you upgrade SIPServer to the latest commit
703 in Git, you must also upgrade Evergreen or, at least, apply the patch
704 for Launchpad Bug 1542495. These two patches are complementary and
705 cannot be applied independently of one another.
707 `open-ils.auth.login`
708 ~~~~~~~~~~~~~~~~~~~~~
709 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
710 API's in the `opensrf_core.xml` file.
715 ---------------------------------------------------------------------
716 --- a/Open-ILS/examples/opensrf_core.xml.example
717 +++ b/Open-ILS/examples/opensrf_core.xml.example
718 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
720 <match_string>open-ils.auth.authenticate.verify</match_string>
721 <match_string>open-ils.auth.authenticate.complete</match_string>
722 + <match_string>open-ils.auth.login</match_string>
723 <match_string>open-ils.auth_proxy.login</match_string>
724 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
725 <match_string>open-ils.actor.user.password</match_string>
726 ---------------------------------------------------------------------
730 Administrators of Evergreen who use RTL locales and who have customized
731 `style-rtl.css.tt2` should now incorporate their customizations into
734 Multi-Time Zone Installations
735 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
737 For Evergreen consortia that span more than one time zone, the following
738 query will adjust all historical, unaged circulations so
739 that if their due date field is pushed to the end of the day, it is done
740 in the circulating library's time zone, and not the server time zone.
742 It is safe to run this after any change to library time zones.
744 Running this is not required, as no code before this change has
745 depended on the time string of '23:59:59'. It is also not necessary
746 if all of your libraries are in the same time zone, and that time zone
747 is the same as the database's configured time zone.
756 for ou_id in select id from actor.org_unit loop
757 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
758 if new_tz is not null then
759 update action.circulation
760 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
761 where circ_lib = ou_id
762 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
771 Deprecation of XUL staff client
772 -------------------------------
773 Starting with the release of 3.0.0, patches that fix XUL bugs will not
774 be merged into master or backported unless they meet one or more of
775 the following conditions:
777 a. the bug is a security issue
778 b. the bug involves the destruction of data
779 c. the bug is a regression of functionality in the XUL staff client
780 introduced by other work done to Evergreen
782 Under no circumstances will XUL staff client feature enhancements be merged.
784 This policy will continue through the 3.0.x and 3.1.x maintenance
785 release cycles, and will become moot upon the release of 3.2.0, when
786 the XUL staff client is slated to be entirely removed.
795 Evergreen 3.0 features a new, modern staff client that runs in the web browser
796 and can be used on desktop and mobile devices. All functional areas of the
797 system, including circulation, cataloging, acquisitions, serials, reports,
798 booking, administration, and offline circulation, are available in the new staff
799 client. Chrome and Firefox are officially supported for use with the web client.
801 Library staff will no longer need to download separate software to perform most
802 actions in Evergreen. A Chrome plugin called Hatch will be available as a
803 separate installation for workstations that require seamless, dialog-free
804 printing to multiple printers.
806 In addition to adding more portability and stability, the new staff client also
807 presents a cleaner and more modern interface for users. By virtue of running in
808 a browser, actions that users are accustomed to performing on other web sites
809 should now be available in the Evergreen client.
811 The old, XUL client will continue to be available to allow for a gradual
812 transition to the browser-based client, but no new features will be added. The
813 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
823 New EDI Order Generator
824 ^^^^^^^^^^^^^^^^^^^^^^^
829 . New database tables exist for configuring vendor-specific EDI order
833 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
836 ** Collection of `edi_attr`s. Each edi_account may be linked to one
838 ** One `edi_attr_set` per known vendor is added to the stock data, matching
839 the stock configuration found in the JEDI template.
840 * `acq.edi_attr_set_map`
841 ** Link between `edi_attr`s and `edi_attr_set`s.
843 . EDI Attribute Sets are manged via a new (browser client only) configuration
844 interface at 'Administration -> Acquisitions Administration -> EDI
847 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
848 is not set, default values will be used. Links between an EDI account
849 and an attribute set are managed in the EDI Accounts configuration
852 . Local modifications to the stock EG JEDI template are managed by modifying
853 and/or adding additional `edi_att_set`s as needed.
855 . A new `edi_order_pusher.pl` script is added which replaces the functionality
856 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
858 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
859 definition is no longer required and can be disabled.
864 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
865 specifies whether PO's generated via the account should be built using
866 EDI attributes or fall back to traditional JEDI A/T template generation.
868 This allows sites to activate EDI attributes on a per-account basis, making
869 it possible to migrate piecemeal to EDI attributes. For the initial roll
870 out of this new feature, no accounts will be configured to use EDI
871 attributes by default.
877 3 Day Courtesy Notice by SMS
878 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
879 New optional SMS text notification to be sent out 3 days prior to the due
880 date of any circulating item for patrons who have an SMS text number and
881 carrier stored in their accounts. This action trigger is disabled by default,
882 but can be enabled and modified by going into 'Administration -> Local Administration ->
883 Notifications / Action Triggers'.
885 You may wish to make use of granularity so that these messages are batched
886 and sent at the same time each day.
891 Add Description Field to Circulation and Hold Configuration Entries
892 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
893 The circulation and hold policy configuration rules now each have a
894 description field. This allows administrators to add comments to
895 describe the purpose of each rule.
900 Apache Internal Port Configuration Option
901 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
902 Apache configuration now supports a new variable which allows admins to
903 specify the port used by Apache to handle HTTP traffic. The value is
904 used for HTTP requests routed from Perl handlers back to the same Apache
905 instance, like added content requests. Use this when running Apache
906 with a non-standard port, typical with a proxy setup. Defaults to "80".
909 -------------------------------------------------------------------
912 PerlSetVar OILSWebInternalHTTPPort "7080"
915 -------------------------------------------------------------------
920 Configurable Bib Record Display Fields
921 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
923 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
924 fields: 'Display Field?' and 'Display XPath'.
926 When 'Display Field' is set to true, data from the field will be extracted
927 from each record and added to a new table of display data for each bib
930 If a value is present in the 'Display XPath' field, this XPath will be
931 applied to the extracted data *after* the base XPath (from the 'XPath'
932 field) is applied to each field.
934 This data acts as a replacement for the various and sundry ways bib record
935 data is currently extracted, including inline XPath in the TPAC, reporter
936 views, real-time 'MVR' compilation from MODS, etc. and will be available
937 to the user interface, notification templates, etc. for rendering bib
940 The browser client gets a new service 'egBibDisplay' which is capable
941 of translating the display field data from various formats into
942 data more suitable for JavaScript usage.
944 The database gets 3 new views for representing display data in various
947 * `metabib.flat_display_entry`
948 ** List of all display fields linked to their configuration.
949 * `metabib.compressed_display_entry`
950 ** Same as `metabib.flat_display_entry` except there's one row
951 per display field type, with 'multi' rows compressed into
952 JSON arrays. Non-multi fields are represented as JSON
954 * `metabib.wide_display_entry`
955 ** Tabular view of display field data, one column per well-known
956 field. Values are represented JSON, consistent with
957 `metabib.flat_display_entry`. The view does *not* contain locally
958 configured display fields, as each field must be encoded in
959 the view and IDL definition. This is essentially a replacement
960 for `reporter.simple_record`.
965 After making changes to display field configuration, it's possible to
966 reingest only display field data in the database using the following:
969 ---------------------------------------------------------------------
970 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
971 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
972 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
973 ---------------------------------------------------------------------
979 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
980 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
981 The existing permission was incorrectly created with a code of
982 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
983 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
984 update changes the permission code to match what the event requires.
990 Hold Targeter V2 Repairs and Improvements
991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
992 * Make the batch targeter more resilient to a single-hold failure.
993 * Additional batch targeter info logging.
994 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
995 * Removes the confusingly named `--target-all` option
996 ** The same behavior can be achieved by using `--retarget-interval "0s"`
997 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
999 New --next-check-interval Option
1000 ++++++++++++++++++++++++++++++++
1001 Specify how long after the current run time the targeter will retarget
1002 the currently affected holds. Applying a specific interval is useful
1003 when the retarget-interval is shorter than the time between targeter
1006 For example, if the targeter is run nightly at midnight with a
1007 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1008 since the holds won't be processed again until 48 hours later. This
1009 ensures that the org unit closed date checks are looking at the correct
1012 This setting overrides the default behavior of calculating the next
1013 retarget time from the retarget-interval.
1015 New --soft-retarget-interval Option
1016 +++++++++++++++++++++++++++++++++++
1017 This is a replacement for (and rebranding of) the `--skip-viable` option.
1018 The new option allows for time-based soft-targeting instead simple binary
1019 on/off soft-targeting.
1021 How soft-targeting works:
1023 * Update hold copy maps for all affected holds
1024 * Holds with viable targets (on the pull list) are otherwise left alone.
1025 * Holds without viable targets are retargeted in the usual manner.
1031 New marc_export --descendants Option
1032 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1034 The `marc_export` script has a new option, `--descendants`. This option
1035 takes one argument of an organizational unit shortname. It works much
1036 like the existing `--library` option except that it is aware of the
1037 org. tree and will export records with holdings at the specified
1038 organizational unit and all of its descendants. This is handy if you
1039 want to export the records for all of the branches of a system. You
1040 can do that by specifying this option and the system's shortname,
1041 instead of specifying multiple `--library` options for each branch.
1043 The `--descendants` option can be repeated, as the `--library` option can.
1044 All of the specified org. units and their descendants will be included
1045 in the output. It can also be combined with individual `--library`
1046 options when necessary.
1051 RTL and LTR Public Catalog Stylesheets Merged
1052 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1053 The RTL stylesheet for the public catalog,
1054 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1055 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1056 template will provide RTL or LTR styles based on the value of
1057 the `rtl` flag of the active locale. An `rtl` variable is also available
1058 in the template to allow the correct style to be chosen.
1063 Miscellaneous Improvements
1064 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1066 * If a filter is in effect in the Library Settings Editor,
1067 the filter will continue to be applied after a user
1068 changes the selected library.
1069 * Copy templates used for serials now correctly link to age
1070 protection rules and MARC item type values (for the
1071 "Circ as Type" field). During upgrade, the database update
1072 will set to NULL any age protection and circ as type fields
1073 in serial copy templates that do not point to defined values.
1078 Obsolete Internal Flag Removed
1079 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1081 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1082 flag was removed from the `config.internal_flags` table. It was
1083 rendered obsolete by the addition of the 3 flags to control the
1084 browse, search, and facet indexing.
1089 Tweaks to Caching/Expiry of Public Catalog Assets
1090 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1091 The default cache expiration time for static assets (e.g.,
1092 CSS, image, and JavaScript files) in the public catalog and
1093 the Kid's PAC has been increased to one year. Links to all
1094 such assets now have a cache-busting value tacked on as a
1095 query parameter. This value is refreshed when `autogen.sh` is
1096 run, but it can also be manually set by adjusting the
1097 `ctx.cache_key` Template Toolkit variable.
1102 Action/Trigger Events Data Purging
1103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1105 Action/Trigger event definitions have a new field called 'Retention
1106 Interval'. When an optional interval value is applied, events and
1107 template output data linked to the event definition will be deleted
1108 from the database once they reach the specified age.
1110 Retention Interval Restrictions for Passive Hooks
1111 +++++++++++++++++++++++++++++++++++++++++++++++++
1113 Restrictions are placed on retention interval values for event definitions
1114 using passive hooks to prevent data from being deleted while it's still
1115 needed by the system.
1117 The presence of event data is how the system knows not to send duplicate
1118 events. As long as a scenario exists where a duplicate event may be
1119 generated, the events must be retained.
1121 To apply a retention interval value to a passive-hook event definition:
1123 * The event definition must have a max_delay value.
1124 * The retention interval must be larger than the difference between
1125 the `delay` and `max_delay` values.
1127 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1128 interval must be greater than 3 days to ensure no duplicate events are
1129 created between the first event on day 7 and the end of the event validity
1135 A new `purge_at_events.sh` script is installed in the bin directory
1136 (typically `/openils/bin`) which should be added to CRON for regular
1139 NOTE: On large data sets, this script can take a long time to run and
1140 create higher than normal I/O load as it churns though the event and
1141 event_output tables. You may wish to run the script by hand the first
1142 time so it can be monitored. It can be run in psql like so:
1145 ---------------------------------------------------------------
1146 SELECT action_trigger.purge_events();
1147 ---------------------------------------------------------------
1149 NOTE: On *very* large data sets (10s to 100s of millions of event and
1150 event_output rows), it may be advisable to first repopulate the `event`
1151 and `event_output` tables with only the desired data before starting
1152 regular purges. This can be done, for example, using the copy to temp
1153 table, truncate source table, repopulate source table from temp table
1154 approach. This will be much faster than the `purge_events()` function
1155 in cases where most of the data will be purged.
1160 A number of `action_trigger.hook` entries which have always been treated
1161 as active hooks, though are configured as passive hooks, have been
1162 updated to properly reflect the non-passive-ness. This allows for
1163 simpler configuration of their retention interval values.
1169 Remove JSPAC Redirects
1170 ^^^^^^^^^^^^^^^^^^^^^^
1171 Future versions of Evergreen will no longer contain automatic redirects
1172 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1173 that the JSPAC is no longer supported. Existing sites, however, may
1174 wish to retain JSPAC redirects in their Apache configuration files since
1175 JSPAC URLs may still be used in the wild to access their catalogs.
1177 The original JSPAC URL redirects are all retained in the file
1178 `Open-ILS/examples/jspac_redirects.conf` for reference.
1188 New open-ils.auth.login API
1189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1190 The `open-ils.auth` service has a new API for requesting an authentication
1191 token. It performs the same steps as the
1192 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1193 using the bare password. No intermediate password hashing is required.
1195 The paramaters are the same as the `.complete` call with a few modifications.
1197 1. Using the generic 'identifier' parameter in combination with the
1198 'org' parameter allows the API to reliably determine if an identifier
1199 value is a username or barcode. The caller is no longer required to
1200 make that determination up front.
1202 2. The 'nonce' parameter is no longer used.
1208 Batch Patron Contact Invalidation
1209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1210 The following methods are used to mark patron contact fields
1211 as invalid by moving the invalid value to a standing penalty:
1213 * `open-ils.actor.invalidate.email`
1214 * `open-ils.actor.invalidate.day_phone`
1215 * `open-ils.actor.invalidate.evening_phone`
1216 * `open-ils.actor.invalidate.other_phone`
1218 These methods now accept a fifth argument specifying the value
1219 of the contact field, e.g., a specific phone number or email
1220 address. If supplied, and if a specific patron ID (the first
1221 argument) is not supplied, all patrons with that specific contact
1222 value will have it marked invalid.
1232 Pure-SQL catalog searching
1233 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1234 Public and staff catalog search is now both more accurate and faster
1235 by redesigning how the visibility of records is calculated.
1245 Authority Record and Headings Browse Improvements
1246 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1247 Various improvements are made to support for authority records
1248 and headings browsing:
1250 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1251 headings from authority records. Since the MODS and MADS stylesheets
1252 extract headings in similar ways, duplicate browse entries are now
1253 much less likely to occur.
1254 * A new configuration table, `authority.heading_field`, is now used
1255 to specify how headings should be extracted from authority records.
1256 * Related headings can now be identified as narrower or broader when
1257 browsing in the public catalog.
1258 * See references are now more reliably included in the browse list.
1259 * Scope (public) notes now display only under the main heading.
1260 * There is now a global flag, Display related headings (see-also) in browse,
1261 that can be used to control whether related headings (see-alsos) are
1262 displayed in the public catalog list.
1263 * A complete set of thesauruses are now included in the seed data. Thesauruses
1264 can now be identified using short and long codes.
1265 * The labels for see and see-also references in the public catalog are
1266 a bit more patron-friendly, and can now be tweaked via TPAC template
1267 customization in the browse.tt2 file.
1273 Copy Tags and Digital Bookplates
1274 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1275 Copy tags will allow staff to apply custom, pre-defined labels or tags
1276 to copies. Copy tags are searchable in both the staff client and public
1277 catalog. This feature was designed to be used for Digital Bookplates to
1278 attach donation or memorial information to copies, but may be used for
1279 broader purposes to tag items.
1281 Each copy tag can either be publicly-visible or visible only to staff.
1282 Copy tags also have types that can be used for restricting catalog
1283 searches on copy tags to particular types.
1285 Copy tags are displayed in the copy table in the record summary page in
1286 the public catalog, and a new library setting can be used to add
1287 a "Digital Bookplate" search field. Copy tags can also be used
1288 as a search filter, e.g.,
1290 * `copy_tag(bookplate, jane smith)`: search for records that have a
1291 copy tag of type 'bookplate' whose value contains 'jane smith'.
1292 * `copy_tag(*, jane smith)`: search for records that have a
1293 copy tag of any type whose value contains 'jane smith'.
1295 All staff-side interfaces related to copy tags exist only in the web
1296 staff client. There are two new administration interfaces for managing
1297 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1298 button for applying copy tags to copies; that interface can also be
1299 used to create new copy tags on the fly. Furthermore, the copy buckets
1300 interface now has an 'Apply Tags' action for assigning tags to groups
1306 Two new permission are included:
1308 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1309 'Administration -> Server Administration -> Copy Tag Types'
1310 * `ADMIN_COPY_TAG`: required to create a new tag under
1311 'Administration -> Local Administration -> Copy Tags'
1313 The existing permission `UPDATE_COPY` controls whether or not a user
1314 can link copies to tags.
1318 A new library setting, 'Enable Digital Bookplate Search', controls
1319 whether to display a 'Digital Bookplate' field in the search index
1320 drop-downs in the catalog. A 'Digital Bookplate' search will include
1321 all records that have a copy that matches the tag specified by the user.
1322 It should be noted that this library setting does not affect the
1323 display of copy tags on the catalog record summary page.
1328 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1329 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1330 The call number prefix and suffix, when present, are now included in
1331 subfields $k and $m of the 852 field when running `marc_export` with
1332 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1333 server configured to embed item data in 852 fields, the affixes are now
1334 included in subfields $k and $m.
1344 Batch Editing of Patron Records
1345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1346 There is a now a new interface analogous to the Copy Bucket interface
1347 to select and group a set of users into a User Bucket.
1348 The addition of users to a User Bucket is possible from the Patron Search
1349 interface by the use of a new grid Action, and directly on the User Bucket
1350 interface by user barcode. It is also possible to add users to a User
1351 Bucket by uploading a text file that contains a list of user barcodes.
1353 From this interface it is possible to perform a set of specific batch update
1354 operations on user records.
1359 These fields can now be changed in batch via an action on the User Bucket
1360 grid if the staff user has the `UPDATE_USER` permission:
1363 * Primary Permission Group (group application permissions consulted)
1365 * Home Library (`UPDATE_USER` checked against both old and new value)
1366 * Privilege Expiration Date
1367 * Barred flag (`BAR_PATRON` permission consulted)
1368 * Internet Access Level
1370 Changes made in this interface can be rolled back.
1372 As a batch process, rather than a direct edit, this mechanism explicitly skips
1373 processing of Action/Trigger event definitions for user update.
1378 The batch edit mechanism also allows for the batch deletion of user. The staff
1379 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1381 Changes made in this interface can be rolled back.
1383 As a batch process, rather than a direct edit, this mechanism explicitly skips
1384 processing of Action/Trigger event definitions for user deletion.
1386 This mechanism does not use the Purge User functionality, but instead simply
1387 marks the users as deleted.
1389 Editing Statistical Category Entries
1390 ++++++++++++++++++++++++++++++++++++
1392 All users in the bucket can have their Statistical Category Entries
1393 modified. Unlike user data field updates, modification of Statistical
1394 Category Entries is permanent and cannot be rolled back.
1396 As a batch process, rather than a direct edit, this mechanism explicitly skips
1397 processing of Action/Trigger event definitions for user update.
1399 New Service Requirement
1400 +++++++++++++++++++++++
1402 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1403 unused in production. If this service has been removed from the configuration
1404 of a live Evergreen instances, it will need to be added back in order for
1405 batch user editing to succeed.
1410 Honor Timezone of the Acting Library
1411 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1416 * Display day-granular due dates in the circulating library's timezone.
1417 * Only display the date portion of the due date for day-granular circulations.
1418 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1419 * Provide infrastructure for more advanced formatting of timestamps.
1420 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1425 This is a followup to the work done for 2.12, where we added the ability
1426 for the client to specify a timezone in which timestamps should be interpreted
1427 in business logic and the database.
1429 Most specifically, this work focuses on circulation due dates and the closed
1430 date editor. Due dates, where displayed using stock templates (including
1431 receipt templates) and used for fine calculation, are now manipulated in the
1432 library's configured timezone. This is controlled by the new 'lib.timezone'
1433 setting available via the Library Settings Editor, loaded from the server when
1434 required. Additionally, closings are recorded in the library's timezone so that
1435 due date calculation is more accurate. The closed date editor is also
1436 taught how to display closings in the
1437 closed library's timezone. Closed date entries also explicitly record if they
1438 are a full day closing, or a multi-day closing. This significantly simplifies
1439 the editor, and may be useful in other contexts.
1441 To accomplish this, we use the moment.js library and the moment-timezone addon.
1442 This is necessary because the stock AngularJS date filter does not understand
1443 locale-aware timezone values, which are required to support DST. A simple
1444 mapper translates the differences in format values from AngularJS date to
1447 Of special note are a set of new filters used for formatting timestamps under
1448 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1449 filters provide the functionality, and autogrid is enhanced to make use of
1450 these where applicable. egGrid and egGridField are also taught to accept
1451 default and field-specific options for applying date filters. These filters may
1452 be useful in other or related contexts.
1454 The egDueDate filter, used for all existing displays of due date via Angular
1455 code, intentionally interprets timestamps in two different ways WRT timezone,
1456 based on the circulation duration. If the duration is day-granular (that is,
1457 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1458 of seconds) then the date is interpreted as being in the circulation library's
1459 timezone. If it is an hourly loan (any duration that does not meet the
1460 day-granular criterium) then it is instead displayed in the client's timezone,
1461 just as all other timestamps currently are, because of the previous Evergreen
1464 The public catalog is adjusted to always display the due date in the circulating
1465 library's timezone. Because the public catalog displays only the date portion of the due
1466 date field, this difference is currently considered acceptable. If this proves
1467 to be a problem in the future, a minor adjustment can be made to match the
1468 egDueDate filter logic.
1470 Now that due dates are globally stored in the configured timezone of the
1471 circulating library, the automatic adjustment to day-granular due dates needs
1472 to take those timezones into account.
1474 An optional SQL command is provided by the upgrade script to retroactively
1475 adjust existing due dates after library configuration is complete.
1481 Enhancements to Hard Due Date Functionality
1482 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1483 It will now be possible to delete Hard Due Date Values for dates that have
1484 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1485 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1486 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1491 Patron Search by Birth Date
1492 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1493 * Now you can include the patron birth year and/or birth month and/or
1494 birth day when searching for patrons using the web staff client.
1495 * Day and month values are exact matches. E.g. month "1" (or "01")
1496 matches January, "12" matches December.
1497 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1498 1915, 1599, etc. For exact matches use the full 4-digit year.
1502 Patron Search from Place Hold
1503 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1504 This feature allows staff members, when placing a
1505 hold on behalf of a patron in the web staff client, to search for
1506 patrons by names and other searchable patron information, rather than
1507 relying on barcode alone. In particular, after performing a catalog
1508 search or going to a specific bib record and clicking the 'Place Hold'
1509 button, the form now includes a 'Patron Search' button. This button
1510 will open a dialog allowing the staff member search for and select
1516 Retrieve Recent Patrons
1517 ^^^^^^^^^^^^^^^^^^^^^^^
1519 Adds a new library setting 'Number of Retrievable Recent Patrons'
1520 ('ui.staff.max_recent_patrons') that specifies the number of recently
1521 retrieved patrons that can be re-fetched from the staff client.
1523 A value of 0 means no recent patrons can be retrieved.
1524 A value greater than 1 means staff will be able to retrieve multiple
1525 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1527 The default value is 1 for backwards compatibility.
1534 Fuller title in XUL client Simplified Pull List
1535 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1536 The Simplified Pull List in the XUL client will now display subfields 245$n and
1537 $p in the title field. The addition will make it easier for staff to distinguish
1538 between different parts or seasons in a series.
1544 Transit Cancel Time and Terminology Change
1545 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1550 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1551 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1552 are preserved in the database, though still not visible to the end user in the staff client.
1553 This allows for better tracking of when transits are canceled for the purposes of knowing
1554 which staff member canceled the transit, etc.
1556 NOTE: This change may require the re-creation of transit reports to filter out canceled
1557 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1558 Is NULL' will suffice.
1560 "Canceled Transit" Terminology Change
1561 +++++++++++++++++++++++++++++++++++++
1563 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1564 For internal continuity, however, the following permission codes have not changed:
1567 * `ABORT_REMOTE_TRANSIT`
1568 * `ABORT_TRANSIT_ON_LOST`
1569 * `ABORT_TRANSIT_ON_MISSING`
1577 Offline Circulation Available in Web Staff Client
1578 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1579 Offline circulation is now available in the web staff client. In order to use the
1580 offline interface, users must first log into the web staff client, perform
1581 a patron search, select a user from the results, and open the patron editor
1582 interface to collect all the relevent configuration information for the
1583 workstation. In addition, the offline interface available from the Circulation
1584 menu provides a 'Download block list' button for users who are logged in.
1586 As is the case in the old staff client, users can check materials in and out,
1587 renew items, and create new patron accounts while offline. The patron fields
1588 available in the offline patron registration editor are the same ones that
1589 are available to staff when working online.
1593 Add Circ Modifier to Record Detail Page in Staff TPAC
1594 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1595 The circulation modifier field is added to the table of copies to make
1596 more information available to staff without having to open
1603 Date+Time Format Settings for Web Client
1604 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1606 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1607 and adds two settings for use with the webstaff client:
1609 * 'Format Dates with this pattern'
1610 * 'Format Date+Time with this pattern'
1612 These settings use format strings as documented here:
1614 https://docs.angularjs.org/api/ng/filter/date
1616 There is overlap with how the Dojo formats worked, but also some differences.
1618 The original 'Format Dates' and 'Format Times' settings worked together, but the
1619 new settings work independently. Certain field elements will use one, and
1620 certain field elements will use the other. These distinctions are hard-coded
1621 in the various UI templates, with the idea being that timestamp fields in
1622 which the date component alone is sufficient information (for example, date of birth)
1623 will use the 'Format Dates' setting. Fields where the time component is
1624 important (for example, checkout time) will use the 'Format Date+Time' setting.
1626 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1627 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1633 Global Option to Remove Sound for a Specific Event
1634 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1635 A new `nosound.wav` file has been added to the web client. The file can be used
1636 to globally disable audio alerts for a specific event on an Evergreen system.
1638 For example, to silence the alert that sounds after a successful patron search:
1642 mkdir -p /openils/var/web/audio/notifications/success/patron/
1643 cd /openils/var/web/audio/notifications/success/patron/
1644 ln -s ../../nosound.wav by_search.wav
1651 The official Evergreen manual has been split into eight new manuals, each
1652 designed for a specific audience. This new approach is designed to make
1653 the documentation more readable and usable.
1655 The specific audiences for the new manuals are:
1657 * Acquisitions staff
1660 * Public services staff who use the public catalog
1662 * System administrators who use the command line
1663 * System administrators who use the Web client
1664 * System administrators and programmers who wish to integrate Evergreen
1665 with other technologies
1667 All manuals are available at http://docs.evergreen-ils.org
1673 Improvements to ebook API
1674 ^^^^^^^^^^^^^^^^^^^^^^^^^
1676 Evergreen now supports checking out and placing holds on
1677 OverDrive and OneClickdigital ebook titles from within the public
1678 catalog. This is an experimental feature. It is not recommended for production
1679 use without careful testing.
1681 When ebook integration is enabled, a "Check Out E-Item" link will be
1682 displayed when viewing an ebook title from a supported vendor in the
1683 catalog. Clicking on the link allows the user to check out and download
1684 that title from the vendor directly within the catalog.
1686 If no copies are available for the title, a "Place Hold on E-Item" link
1687 is displayed instead, and the user may place a hold on the title. (Note
1688 that some vendors require the user's account to have an email address
1689 before permitting a hold.)
1691 My Account includes the ability to view current ebook checkouts and
1692 holds, download already-checked-out titles, and cancel holds.
1694 For API integration to work, you need to request API access from the
1695 vendor, and the vendor must have a way of authenticating your patrons.
1696 Your Evergreen system also needs to be configured for ebook API
1697 integration, following the instructions in the command line system
1698 administration manual
1701 This feature assumes that you are importing MARC records supplied by the
1702 vendor into your Evergreen system, using Vandelay or some other MARC
1703 import method. This feature does not search the vendor's online
1704 collections or automatically import vendor records into your system; it
1705 merely augments records that are already in Evergreen.
1707 Improvements to Bill Payment Pages
1708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1709 The bill payment pages in the public catalog have been revamped
1712 * use the term "charges" instead of "fees"
1713 * include images of credit cards accepted
1714 * make the default print receipt template match other itemized receipts;
1715 note that this change is not automatically applied when upgrading.
1716 * display billing type
1717 * add button to pay only selected charges
1718 * reformat the credit card number input page
1724 Clickable Copy Locations
1725 ^^^^^^^^^^^^^^^^^^^^^^^^
1726 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1727 the associated copy location will display as a link in the public catalog summary display.
1728 This link can be useful for retrieving maps or other directions to the copy
1729 location to aid users in finding material.
1734 Download Checkout History CSV Fixed for Large Number of Circulations
1735 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1736 Downloading checkout history as a CSV from My Account has been fixed
1737 for users with a large circulation history. Previously, this would
1738 time out for patrons with more than 100 or so circulations.
1740 This feature no longer uses the action/trigger mechanism and the public catalog
1741 now generates the CSV directly. The old action/trigger code is still
1742 present in the database and should be removed at some point in the
1748 Google Books Preview Rewrite
1749 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1750 The Google Books Preview functionality in record detail pages has been
1751 rewritten to modernize its style and optimize its performance:
1753 * The Dojo JavaScript framework is no longer used, saving approximately
1754 150K of JavaScript and CSS and four network requests per page load.
1755 * The Embedded Viewer is not loaded unless a possible preview is found,
1756 saving more network and memory overhead.
1757 * The Google Books Loader is used to load the Embedded Viewer instead of the
1758 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1760 * All variables are self-contained and do not pollute the global namespace.
1761 * Event listeners are registered to handle clicks, rather than attaching
1762 `href="javascript:function()"` to <a> elements.
1763 * Book previews are displayed in a panel sized according to the viewport
1764 of the browser, improving its appearance on both mobile and desktop
1766 * The rewritten code is now served up directly from
1767 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1772 jQuery for the Public Catalog
1773 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1774 This release adds optional support for jQuery in the public catalog. This support
1775 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1776 `config.tt2` template.
1782 New Popularity Parameters
1783 ^^^^^^^^^^^^^^^^^^^^^^^^^
1784 New popularity parameters for in-house use over time and for count of distinct
1785 organizational units that own a title are now available. Evergreen sites
1786 can use these parameters to create new statistical popularity badges for
1787 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1789 The in-house use parameters will apply a badge to titles that have the most
1790 in-house use activity over time. The organizational unit count parameter
1791 will apply a badge to titles owned by the most number of libraries in a
1792 consortium. Ownership is determined by the copy's circulation library.
1797 Option to Suspend Holds at the Time They are Placed
1798 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1799 Users now have the option to suspend a hold at the same time they place the
1800 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1801 who want to suspend a hold at the time it is placed. There is also an option
1802 to set the activation date at the same time. This option is also available
1803 when placing holds on a batch of titles from 'My List' and will apply to
1804 all the titles in the batch.
1815 Fix to reporter.classic_current_circ View
1816 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1817 The `reporter.classic_current_circ` view, which is part of some
1818 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1819 has been fixed to not exclude loans for patrons who do not have a
1820 billing address set. Users of this view should rerun
1821 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1826 New Report Source Table Allowing Report of "Last" Deleted copy
1827 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1829 This source table allows you to construct a clever aggregate report template
1830 which will report bibliographic IDs where a library or a group of libraries
1831 no longer have a copy attached but *had* a copy attached. This is especially
1832 useful when a holdings sync is required with an external vendor.
1835 Instructions for creating a report template with this source:
1837 * Create a new report template using "Library Holdings Count with Deleted" as the source
1838 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1839 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1840 * 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"
1841 * Add "Bib ID" to Displayed Fields
1842 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1843 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1844 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1847 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1848 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1849 specified date range. Unfortunately the user will have to manually type the date range without the date
1850 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1851 copy and more than two deleted copies."
1856 Add Provider to Provider Note Link
1857 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1858 The Provider reporting source now includes a link to the Provider Note reporting source.
1863 Link ILS User and Working Location Reporting Sources
1864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1865 The Working Location reporting source now has labels
1866 and it is now linked to the ILS User reporting source, allowing
1867 reports to display or filter on staff working location.
1872 New Circulation Report Source "All Circulation Combined Types"
1873 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1875 This report source will allow you to create a single report template for all of the following:
1878 * In-house uses of non-cataloged items
1880 * Circulations of non-cataloged items
1882 To distinguish between these different types of library use, it's important to display these columns
1883 in your report templates:
1892 Reports Template Searching
1893 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1894 A new form appears along the top of the reports interface for searching
1895 report templates. Once found, typical template actions (e.g. create new
1896 report) are available from within the results interface.
1898 Searches may be performed across selected (visible) folders or all
1899 folders visible to the logged in user.
1901 Searches are case-insensitive, any word order, with left-anchored words.
1902 All searched words must appear in at least one of the searched fields.
1907 * Searching for 'stat cat' matches:
1909 ** statistical category
1910 ** categories, statistical
1911 ** patrons (stat cat)
1912 * Searching for 'stat cat' does not match:
1914 *** both words must be present in the searched field(s)
1916 *** location contains 'cat' but it's not left-anchored.
1921 The templates, reports, and output interfaces now support paging via
1922 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1934 Web Staff Client Serials Module
1935 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1936 The serials module has been ported over to the web staff
1937 client, implementing a unified serials interface that combines
1938 ideas from both the serial control view and alternate serials
1939 control view from the old staff client.
1941 In addition to carrying over functionality that was available
1942 in the old staff client, several new features are included:
1944 * the ability to save prediction pattern codes as templates
1945 that can be shared and reused within an Evergreen database
1946 * a more streamlined interface for managing subscriptions,
1947 distributions, and streams
1948 * it is no longer necessary to create a starting issue in
1949 order to predict a run of issues; the dialog box for
1950 generating a set of predicted issues now lets you specify
1951 the starting point directly.
1952 * the ability to more directly edit MFHDs
1954 The new serials interfaces can be accessed from the record
1955 details page via a Serials drop-down button that links to
1956 a subscription management page, a quick-receive action, and
1957 a MFHD management page. There is also a new 'Serials Administration'
1958 page where prediction pattern and serial copy templates can
1969 SIP Bugfix Changes How Encoding Is Determined in Configuration
1970 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1972 The combined fix for the above mentioned SIP bugs alters the way that
1973 SIPServer looks up the output encoding in the configuration file (typically
1974 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1977 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1978 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1979 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.
1980 4. If none of the above exist, then the default encoding (ASCII) is used.
1982 Number 3 is provided to ease the transition to the new code. It is
1983 the current location of the +encoding+ element in the sample
1984 configuration file and as such, where it is likely to be found in
1985 actual files. It is recommended that you alter your configuration to
1986 move this element out of the +implementation_config+ element and into
1987 its parent +institution+ element. Ideally, SIPServer should *not* look into
1988 the implementation config, and this check may be removed at some time
1996 Web Client Acknowledgments
1997 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1999 The project to develop a new browser-based web client launched four
2000 years ago at the September 2013 Evergreen developer hack-a-way when the
2001 developer community voted to move away from the XUL client and explore other
2002 platforms. The first web client preview became available in Evergreen 2.7 when
2003 circulation was available in the new platform.
2005 The browser-based client is available due to the work of many coders, testers,
2006 bug reporters, documentors, translators, project managers, spec writers, funders
2007 and other contributors over the past four years.
2009 The Evergreen project would like to acknowledge the following organizations
2010 that funded development of the Web Staff Client:
2013 * British Columbia Libraries Cooperative
2014 * Consortium of Ohio Libraries
2016 * Georgia Public Library Service
2017 * Grand Rapids Public Library
2019 * Kenton County Public Library
2020 * King County Library System
2023 * Pennsylvania Integrated Library System
2024 * Pioneer Library System
2027 The Evergreen project would also like to thank the following individuals who
2028 contributed code, translations, documentation patches, tests, bug reports,
2029 technical specifications, and project management to the Web Staff Client:
2066 * Freddy Enrique Pelayo Huapalla
2092 Evergreen 3.0 Acknowledgments
2093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2095 The Evergreen project would like to acknowledge the following
2096 organizations that commissioned developments in this release of
2100 * British Columbia Libraries Cooperative (BC Sitka)
2102 * Georgia Public Library Service
2103 * King County Library System
2105 * Pennsylvania Integrated Library System
2106 * Pioneer Library System
2108 We would also like to thank the following individuals who contributed
2109 code, translations, documentation patches, and tests to this release of
2158 We also thank the following organizations whose employees contributed
2161 * British Columba Libraries Cooperative
2165 * Emerald Data Networks, Inc.
2166 * Equinox Open Library Initiative
2168 * Grand Rapids Public Library
2169 * Indiana State Library
2171 * King County Library System
2172 * Lake Agassiz Regional Library
2173 * Laurentian University
2174 * Linn-Benton Community College
2176 * Merrimack Valley Library Consortium
2178 * North of Boston Library Exchange
2179 * Pennsylvania Integrated Library System
2180 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2182 * Traverse Area District Library
2184 We regret any omissions. If a contributor has been inadvertently
2185 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob