1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7.
10 * Fixes an issue that caused records with located URIs to be
11 retrieved in Copy Location and Copy Location Group searches.
12 * Fixes an error message that appeared in the search box
13 while placing hold after an advanced search.
14 * Fixes regression errors in the search results page.
15 * Removes redundant call numbers from the Show More Details
17 * Adds spaces between subfields when suggesting a call
18 number for a new volume.
19 * MarcXML exports from the MARC Batch Import/Export ->
20 Export Records screen now downloads the file, rather than opening
22 * Adds some padding to the bottom of Web Client interfaces.
23 * Fixes an issue that prevented users from searching for
24 receivable issues using Database ID or ISSN in the Serials
25 Batch Receive interface.
26 * The Item Status Circulation Library column now displays a
27 shortname rather than the full library name.
28 * The Item Status Remaining Renewals column now displays
30 * The Item Status now has a "Last Renewal Workstation" column
32 * Fixes the circulation counts displayed in Item Status Details.
33 * Staff members can now manually override the patron juvenile
34 flag value, regardless of the patron's date of birth.
35 * Checkboxes on patron registration screen are now properly aligned
37 * The user permission group dropdowns in the patron registration,
38 edit, and search interfaces now have scrollbars.
39 * The Merge Patrons interface now displays the date of birth.
40 * When a patron summary contains an image of the patron,
41 that image tag now has a null alt attribute to remove it from
42 the flow of a screen reader.
43 * The MARC editor now handles 008 fields better.
44 * Corrects an issue that caused the transit dialog showed the
46 * The cursor in the in-house use screen now automatically goes
48 * The novelist entry in `eg_vhost.conf` includes two new
50 * Corrects an issue with the `--max-sleep` argument on the
51 `action_trigger_runner.pl` support script.
52 * Corrects an issue with how the `eg_pbx_allocator.pl` script
53 detects an existing lock file.
54 * The 3.0.2-3.0.3 upgrade script disables triggers before
55 recalculating bib visibility.
59 We would like to thank the following individuals who contributed code,
60 tests and documentation patches to the 3.0.8 point release of
85 This release contains bug fixes improving on Evergreen 3.0.6.
87 * Fixes a performance issue with the Patron Billing History screen and
88 other screens that cause Flattener.pm to re-create joins
90 * Fixes an issue that prevented patron alerts from showing to staff at
92 * Corrects the "Holdable" attribute display on the Item Status detailed
94 * Fixes the ability to delete multiple copies from Item Status.
98 We would like to thank the following individuals who contributed code,
99 tests and documentation patches to the 3.0.7 point release of
113 This release is a security release that fixes cross-site scripting
114 (XSS) vulnerabilities in the Evergreen public catalog. This release
115 also includes several other bugfixes improving on Evergreen 3.0.5.
117 Security Issue: XSS Vulnerability in Public Catalog
118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119 This release fixes several cross-site scripting (XSS) vulnerabilities
120 in the public catalog. When upgrading, Evergreen administrators should
121 review whether any of the following templates have been customized
122 or overridden. If so, either the template should be replaced with the
123 stock version or the XSS fix (which entails adding the `| html` filter
124 in several places) applied to the customized version.
126 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
127 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
128 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
130 Note that exploiting the XSS vulnerabilities fixed in this release
131 would require either the ability to create maliciously-constructed
132 MARC bibliographic or holdings records or the ability to set a
133 maliciously constructed organizational unit name.
137 Evergreen 3.0.6 also includes the following changes:
139 * When using 'Selection Lists -> Edit MARC Order Record' in the web
140 staff client, now only one click is required to save the MARC
141 record rather than two.
142 * The volume/copy editor in the web staff client now better handles
143 editing multiple items that have different sets of statistical
144 category values assigned to them.
145 * The act of merging bibliographic records now updates bookbags
146 that referred to the source bibliographic record rather than
147 effectively deleting entries for that record.
148 * Additional columns were added to the Holds Pull List in the
150 * The patron registration form in the web staff client now correctly
151 manages setting user preferences.
152 * An error in a pgTAP unit test was corrected.
156 We would like to thank the following individuals who contributed code,
157 tests and documentation patches to the 3.0.6 security release of
173 This release contains bug fixes improving on Evergreen 3.0.4.
175 * The MARC Editor in the Web staff client now wraps long fields.
176 * The MARC Editor no longer allows catalogers to enter new lines
178 * Fixes an issue that prevented serials items from being deleted or
180 * The Web staff client Check In screen no longer reloads the whole
181 page multiple times each time an item is scanned.
182 * Fixes an issue that displayed the oldest -- rather than the newest
183 -- transit in the Web staff client Item Status page.
184 * Fixes an issue that prevented the reports module from being displayed
186 * Fixes an issue in the Web staff client reports module that caused
187 syntax errors in reports that use virtual fields and joins.
188 * Fixes an issue that prevented several dropdown menus in the Web staff
189 client from activating.
190 * Fixes an issue that created duplicate copy data when copies or
191 volumes with parts were transferred.
192 * Fixes the Trim List feature in the Web staff client Check In screen.
193 * The Item Status grid now displays the Circulation Modifier.
194 * Restores missing data from the Profile column in Place Hold patron
196 * Fixes an issue with the http -> https redirect on Apache 2.4.
197 * Fixes an color contrast accessibility issue in the Web staff
198 client and adds underlining to links in grid cells for added accessibility.
199 * Adds automated regression and unit tests for the Web staff client
201 * Adds a process for spell-checking the official documentation.
202 * Adds a script that simplifies the release process related to translations.
207 We would like to thank the following individuals who contributed code,
208 tests and documentation patches to the 3.0.5 point release of
213 * Blake Graham-Henderson
228 This release contains bug fixes improving on Evergreen 3.0.3:
230 * Fixes a bug that caused all searches limited by shelving location to
232 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
233 rather than the ordering agency's SAN.
234 * Fixes a bug that prevented Safari/iOS users from logging in to the
236 * Fixes a bug that prevented users from using the browse interface.
237 * Fixes a bug in the Item Status List view that caused incorrect due
239 * Approval code is now a required field in the web client's patron
240 credit card payment form.
241 * Fixes a bug with credit card payments that caused a receipt to print
242 showing that the patron paid the bill when the payment had not actually
244 * Fixes a bug that prevented the EDI translator from being installed on
246 * Fixes a bug that caused entries to show up multiple times in the
247 Items Out and Holds tabs in the patron record.
248 * Fixes a bug that caused grids on Bills and Patron Messages
249 screens to not display properly.
250 * The following fields are now available for the Checkout and Items Out
257 ** money_summary.balance_owed
258 ** money_summary.total_paid
259 ** money_summary.total_owed
264 * The following fields are now available on the Bill Payment receipt templates:
274 * Payment type is now a column in the payments tab of the patron record
275 Bill History section.
276 * The "Replace Barcode" function now makes it more difficult for staff
277 members to attempt to create blank patron barcodes.
278 * The patron bills screen now prevents staff members from double-clicking
279 on the Apply Payment button (which otherwise would apply two payments).
280 * Fixes a bug that prevented patrons attached to statistical categories
281 from displaying in the patron search-to-hold dialog.
282 * Fixes a performance issue related to uploading CSV files of barcodes
283 to the item status and patron bucket interfaces.
284 * Fixes several small bugs in the Spanish translation.
285 * Fixes a performance bug related to patrons logging in by barcode.
289 We would like to thank the following individuals who contributed code,
290 tests and documentation patches to the 3.0.4 point release of
312 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
313 update the visibility attributes of all bibs that make use of Located URIs or
314 bib sources. It may take a while to run on large datasets. If it it running
315 too long, it can be canceled and the following psql commands will create and
316 run a script that will perform the same action serially over time without
317 blocking writes to bibs:
320 \o /tmp/luri_visibility_update.sql
321 SELECT 'UPDATE biblio.record_entry SET ' ||
322 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
323 'WHERE id = ' || id || '; SELECT ' || id || ';'
324 FROM biblio.record_entry
326 SELECT DISTINCT cn.record
327 FROM asset.call_number cn
329 AND cn.label = '##URI##'
332 FROM asset.uri_call_number_map m
333 WHERE m.call_number = cn.id
336 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
341 \i /tmp/luri_visibility_update.sql
344 It will output the id of each updated bib so that the script can be killed
345 and then edited to remove completed bibs. The remainder can be run at a
348 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
349 we do NOT update the bib's visibility attributes, as doing so causes a loop
350 and an eventual trigger stack violation. This flag should ONLY be used when
351 forcing reingest of record attributes (NOT visibility attributes), search,
352 facet, and display fields, so if using this flag under normal operation,
353 proceed at your own risk and know that Located URI and bib source changes
354 will not be reflected in the visibility attributes of the record.
358 This release contains several bug fixes improving on Evergreen 3.0.1:
360 * Fixes several issues related to the display of located URIs and records with
361 bib sources in search results.
362 * Setting `opac_visible` to false for a copy location group now hides only
363 the location group itself, rather than also hiding every single copy in the
365 * Fixes a bug that prevented the copy editor from displaying the _fine level_
366 and _loan duration_ fields.
367 * The "Edit Items" grid action in the Item Status interface will now open
368 in the combined volume/copy editor in batch. This makes the behavior
369 consistent with the "Edit Selected Items" grid action in the copy
371 * Staff members are now required to choose a billing type when creating a
372 bill on a user account.
373 * The Web client now provides staff users with an alert and option to
374 override when an item with the Lost and Paid status is checked in.
375 * Fixes a bug where the Web client offline circ interface was not able
376 to set its working location.
377 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
379 * The MARC editor in the Web staff client now presents bib sources in
381 * Both circulation and grocery bills are now printed when a staff user selects
382 a patron account and clicks "Print Bills".
383 * Fixes an issue in the XUL serials interface the "Receive move/selected"
384 action from succeeding.
385 * Fixes a typo in the user password testing interface.
389 We would like to thank the following individuals who contributed code,
390 tests and documentation patches to the 3.0.3 point release of
409 This release contains several bug fixes improving on Evergreen 3.0.1:
411 * Copy templates created in XUL Holdings Maintenance will now be
412 automatically converted and displayed in the web staff client's
414 * The list of report templates now includes a column indicating whether
415 the template was originally created in the XUL staff client or the web
416 staff client; staff need to know this since report templates created in
417 one interface cannot be edited in the other.
418 * Call number prefixes and suffixes are now displayed in various grids
419 in the web staff client, including
420 ** Pending Copy Buckets
422 ** Checkin/Capture Holds
424 ** Patron Bills History
431 ** Bib Record View Holds
433 * Many patron fields have been redacted from the web staff client's patron
434 and record holds grids, leaving patron name, username, and ID.
435 * Fixes two bugs where patron records could fail to be saved upon editing.
436 * The web staff patron editor now better warns staff users about
437 duplicate names, IDs, phone numbers, and email addresses.
438 * Human readable labels are now displayed for certain fields in standing
440 * The patron summary in the web staff client now correctly displays
441 primary and secondary ID values.
442 * The web staff client's billing full details page now displays
443 information about the staff user that created a payment.
444 * The web staff client now requires staff users to explicitly set a
445 billing type when adding a manual bill.
446 * The web staff client's patron bill annotation modal now works.
447 * Patron barcode search completion in the web staff client now allows
448 the user to select from all of the matching patron records.
449 * The Hold Shelf Slip print template in the web staff client now has
450 access to the call number.
451 * The Checkout Receipt print template in the web staff client now can
452 include summary financial information, incuding current balance, total
453 paid on outstanding fines, and total owed.
454 * The web staff print templates for current and historical bills can
455 now include copy barcode and title.
456 * Fixes a bug that resulted in some catalog searches unexpectedly
458 * Fixes a bug that resulted in catalog searches that specify a location
459 limit returning incorrect results.
460 * Fixes a bug where deleted copies could make records visible in the
462 * Fixes a bug where certain queries on copies used in the public catalog
464 * Fixes a bug place a hold request in the public catalog could result
465 in "forgetting" the type and library of the user's previous search.
466 * The web staff client now respects staff user session timeouts, and
467 will log out all open tabs if a user's session has timed out.
468 * The web staff Z39.50 page will now give the staff user an alert if
469 they attempt to import a record with a duplicate TCN.
470 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
471 entries from being deleted.
472 * Fixes a bug that made using the volume/copy editor to change a copy's
474 * The administration interface for hard due dates now ensures that
475 new (or edited) ceiling dates have their time component set to end
476 of day, resolving an issue where ceiling dates would not be applied
477 during the ceiling date itself.
478 * The web staff client can now include dynamic information in browser
479 tab titles, e.g., "Smith, Jane - Checkout".
480 * The Concerto sample data set now includes data allowing for testing
481 placing holds on monographic parts.
482 * Asset merging during bibliographic record merging now correctly
483 recognizes call number prefixes and suffixes and deletes disused
485 * Fixes a bug where displaying user surveys could result in PCRUD
487 * Fixes a bug where pg_restore of an Evergreen database could fail
488 to create certain indexes on the `actor.usr` table.
492 We would like to thank the following individuals who contributed code,
493 tests and documentation patches to the 3.0.2 point release of
524 This release contains several bug fixes improving on Evergreen 3.0.0
526 * Fixes a bug in the web staff client that prevented initials from being
527 stored with copy notes.
528 * Adds billing types that may have been missed by systems that were
529 running Evergreen prior to the 1.4 release.
530 * Fixes a web staff client bug with the CSV export option available from
531 the Import Queue in the MARC Batch Import/Export interface.
532 * Adds the missing copy alert field in the web client's volume/copy
534 * Fixes a bug where the setting to require date of birth in patron
535 registration was not being honored in the web staff client.
536 * Fixes a bug in the web staff client patron registration form where the
537 password wasn't generating from the last four digits of the patron's
539 * Fixes an issue in the web staff client where the complete barcode did
540 not display in some interfaces when partial barcodes were scanned.
541 * Fixes an HTML error in the new copy tags that display on the record
543 * Fixes a web staff client bug where recording a large number of in-house
544 uses at one time doesn't display a confirmation dialog once it hits the
546 * Adds a _Print Full Grid_ action in the web staff client
547 holds pull list to allow staff to print the entire pull list as it
548 displays on the screen. This change also changes the _Export CSV_ action
549 to an _Export Full CSV_ option.
550 * Fixes an issue with the Patron Messages interface that prevented it
551 from saving column configuration changes in the web staff client.
552 * Fixes a bug in the web staff client where a billing prompt did not
553 correctly display after marking an item damaged in those systems that
554 have enabled the setting to bill for damaged items.
555 * Adds an option to the specific due date feature that allows saving
556 that due date until logout. This allows all circulations from a given
557 workstation to be due on the same date.
561 We would like to thank the following individuals who contributed code,
562 tests and documentation patches to the 3.0.1 point release of
584 The minimum version of PostgreSQL required to run Evergreen 3.0 is
585 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
587 Change to Names of Shared Libraries
588 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
589 OpenSRF 3.0 changes how the shared libraries for services written in
590 C are named. If upgrading from an earlier version of Evergreen,
591 `opensrf.xml` should be edited so that shared library file names
592 listed in the `<implementation>` tag start with "lib". For example,
595 ---------------------------------------------------------------------
597 <language>C</language>
598 <implementation>oils_cstore.so</implementation>
599 ---------------------------------------------------------------------
601 should be changed to:
604 ---------------------------------------------------------------------
606 <language>C</language>
607 <implementation>liboils_cstore.so</implementation>
608 ---------------------------------------------------------------------
610 SIP Bugfix Requires SIPServer Upgrade
611 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
613 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
614 crash" requires that you also upgrade SIPServer with the fix for
615 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
616 SIP client problems." This means that if you use SIP2 with Evergreen,
617 you must also upgrade SIPServer to the latest commit in the Git
618 repository. Conversely, if you upgrade SIPServer to the latest commit
619 in Git, you must also upgrade Evergreen or, at least, apply the patch
620 for Launchpad Bug 1542495. These two patches are complementary and
621 cannot be applied independently of one another.
623 `open-ils.auth.login`
624 ~~~~~~~~~~~~~~~~~~~~~
625 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
626 API's in the `opensrf_core.xml` file.
631 ---------------------------------------------------------------------
632 --- a/Open-ILS/examples/opensrf_core.xml.example
633 +++ b/Open-ILS/examples/opensrf_core.xml.example
634 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
636 <match_string>open-ils.auth.authenticate.verify</match_string>
637 <match_string>open-ils.auth.authenticate.complete</match_string>
638 + <match_string>open-ils.auth.login</match_string>
639 <match_string>open-ils.auth_proxy.login</match_string>
640 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
641 <match_string>open-ils.actor.user.password</match_string>
642 ---------------------------------------------------------------------
646 Administrators of Evergreen who use RTL locales and who have customized
647 `style-rtl.css.tt2` should now incorporate their customizations into
650 Multi-Time Zone Installations
651 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
653 For Evergreen consortia that span more than one time zone, the following
654 query will adjust all historical, unaged circulations so
655 that if their due date field is pushed to the end of the day, it is done
656 in the circulating library's time zone, and not the server time zone.
658 It is safe to run this after any change to library time zones.
660 Running this is not required, as no code before this change has
661 depended on the time string of '23:59:59'. It is also not necessary
662 if all of your libraries are in the same time zone, and that time zone
663 is the same as the database's configured time zone.
672 for ou_id in select id from actor.org_unit loop
673 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
674 if new_tz is not null then
675 update action.circulation
676 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
677 where circ_lib = ou_id
678 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
687 Deprecation of XUL staff client
688 -------------------------------
689 Starting with the release of 3.0.0, patches that fix XUL bugs will not
690 be merged into master or backported unless they meet one or more of
691 the following conditions:
693 a. the bug is a security issue
694 b. the bug involves the destruction of data
695 c. the bug is a regression of functionality in the XUL staff client
696 introduced by other work done to Evergreen
698 Under no circumstances will XUL staff client feature enhancements be merged.
700 This policy will continue through the 3.0.x and 3.1.x maintenance
701 release cycles, and will become moot upon the release of 3.2.0, when
702 the XUL staff client is slated to be entirely removed.
711 Evergreen 3.0 features a new, modern staff client that runs in the web browser
712 and can be used on desktop and mobile devices. All functional areas of the
713 system, including circulation, cataloging, acquisitions, serials, reports,
714 booking, administration, and offline circulation, are available in the new staff
715 client. Chrome and Firefox are officially supported for use with the web client.
717 Library staff will no longer need to download separate software to perform most
718 actions in Evergreen. A Chrome plugin called Hatch will be available as a
719 separate installation for workstations that require seamless, dialog-free
720 printing to multiple printers.
722 In addition to adding more portability and stability, the new staff client also
723 presents a cleaner and more modern interface for users. By virtue of running in
724 a browser, actions that users are accustomed to performing on other web sites
725 should now be available in the Evergreen client.
727 The old, XUL client will continue to be available to allow for a gradual
728 transition to the browser-based client, but no new features will be added. The
729 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
739 New EDI Order Generator
740 ^^^^^^^^^^^^^^^^^^^^^^^
745 . New database tables exist for configuring vendor-specific EDI order
749 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
752 ** Collection of `edi_attr`s. Each edi_account may be linked to one
754 ** One `edi_attr_set` per known vendor is added to the stock data, matching
755 the stock configuration found in the JEDI template.
756 * `acq.edi_attr_set_map`
757 ** Link between `edi_attr`s and `edi_attr_set`s.
759 . EDI Attribute Sets are manged via a new (browser client only) configuration
760 interface at 'Administration -> Acquisitions Administration -> EDI
763 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
764 is not set, default values will be used. Links between an EDI account
765 and an attribute set are managed in the EDI Accounts configuration
768 . Local modifications to the stock EG JEDI template are managed by modifying
769 and/or adding additional `edi_att_set`s as needed.
771 . A new `edi_order_pusher.pl` script is added which replaces the functionality
772 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
774 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
775 definition is no longer required and can be disabled.
780 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
781 specifies whether PO's generated via the account should be built using
782 EDI attributes or fall back to traditional JEDI A/T template generation.
784 This allows sites to activate EDI attributes on a per-account basis, making
785 it possible to migrate piecemeal to EDI attributes. For the initial roll
786 out of this new feature, no accounts will be configured to use EDI
787 attributes by default.
793 3 Day Courtesy Notice by SMS
794 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
795 New optional SMS text notification to be sent out 3 days prior to the due
796 date of any circulating item for patrons who have an SMS text number and
797 carrier stored in their accounts. This action trigger is disabled by default,
798 but can be enabled and modified by going into 'Administration -> Local Administration ->
799 Notifications / Action Triggers'.
801 You may wish to make use of granularity so that these messages are batched
802 and sent at the same time each day.
807 Add Description Field to Circulation and Hold Configuration Entries
808 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
809 The circulation and hold policy configuration rules now each have a
810 description field. This allows administrators to add comments to
811 describe the purpose of each rule.
816 Apache Internal Port Configuration Option
817 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
818 Apache configuration now supports a new variable which allows admins to
819 specify the port used by Apache to handle HTTP traffic. The value is
820 used for HTTP requests routed from Perl handlers back to the same Apache
821 instance, like added content requests. Use this when running Apache
822 with a non-standard port, typical with a proxy setup. Defaults to "80".
825 -------------------------------------------------------------------
828 PerlSetVar OILSWebInternalHTTPPort "7080"
831 -------------------------------------------------------------------
836 Configurable Bib Record Display Fields
837 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
839 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
840 fields: 'Display Field?' and 'Display XPath'.
842 When 'Display Field' is set to true, data from the field will be extracted
843 from each record and added to a new table of display data for each bib
846 If a value is present in the 'Display XPath' field, this XPath will be
847 applied to the extracted data *after* the base XPath (from the 'XPath'
848 field) is applied to each field.
850 This data acts as a replacement for the various and sundry ways bib record
851 data is currently extracted, including inline XPath in the TPAC, reporter
852 views, real-time 'MVR' compilation from MODS, etc. and will be available
853 to the user interface, notification templates, etc. for rendering bib
856 The browser client gets a new service 'egBibDisplay' which is capable
857 of translating the display field data from various formats into
858 data more suitable for JavaScript usage.
860 The database gets 3 new views for representing display data in various
863 * `metabib.flat_display_entry`
864 ** List of all display fields linked to their configuration.
865 * `metabib.compressed_display_entry`
866 ** Same as `metabib.flat_display_entry` except there's one row
867 per display field type, with 'multi' rows compressed into
868 JSON arrays. Non-multi fields are represented as JSON
870 * `metabib.wide_display_entry`
871 ** Tabular view of display field data, one column per well-known
872 field. Values are represented JSON, consistent with
873 `metabib.flat_display_entry`. The view does *not* contain locally
874 configured display fields, as each field must be encoded in
875 the view and IDL definition. This is essentially a replacement
876 for `reporter.simple_record`.
881 After making changes to display field configuration, it's possible to
882 reingest only display field data in the database using the following:
885 ---------------------------------------------------------------------
886 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
887 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
888 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
889 ---------------------------------------------------------------------
895 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
896 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
897 The existing permission was incorrectly created with a code of
898 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
899 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
900 update changes the permission code to match what the event requires.
906 Hold Targeter V2 Repairs and Improvements
907 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
908 * Make the batch targeter more resilient to a single-hold failure.
909 * Additional batch targeter info logging.
910 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
911 * Removes the confusingly named `--target-all` option
912 ** The same behavior can be achieved by using `--retarget-interval "0s"`
913 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
915 New --next-check-interval Option
916 ++++++++++++++++++++++++++++++++
917 Specify how long after the current run time the targeter will retarget
918 the currently affected holds. Applying a specific interval is useful
919 when the retarget-interval is shorter than the time between targeter
922 For example, if the targeter is run nightly at midnight with a
923 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
924 since the holds won't be processed again until 48 hours later. This
925 ensures that the org unit closed date checks are looking at the correct
928 This setting overrides the default behavior of calculating the next
929 retarget time from the retarget-interval.
931 New --soft-retarget-interval Option
932 +++++++++++++++++++++++++++++++++++
933 This is a replacement for (and rebranding of) the `--skip-viable` option.
934 The new option allows for time-based soft-targeting instead simple binary
935 on/off soft-targeting.
937 How soft-targeting works:
939 * Update hold copy maps for all affected holds
940 * Holds with viable targets (on the pull list) are otherwise left alone.
941 * Holds without viable targets are retargeted in the usual manner.
947 New marc_export --descendants Option
948 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
950 The `marc_export` script has a new option, `--descendants`. This option
951 takes one argument of an organizational unit shortname. It works much
952 like the existing `--library` option except that it is aware of the
953 org. tree and will export records with holdings at the specified
954 organizational unit and all of its descendants. This is handy if you
955 want to export the records for all of the branches of a system. You
956 can do that by specifying this option and the system's shortname,
957 instead of specifying multiple `--library` options for each branch.
959 The `--descendants` option can be repeated, as the `--library` option can.
960 All of the specified org. units and their descendants will be included
961 in the output. It can also be combined with individual `--library`
962 options when necessary.
967 RTL and LTR Public Catalog Stylesheets Merged
968 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
969 The RTL stylesheet for the public catalog,
970 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
971 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
972 template will provide RTL or LTR styles based on the value of
973 the `rtl` flag of the active locale. An `rtl` variable is also available
974 in the template to allow the correct style to be chosen.
979 Miscellaneous Improvements
980 ^^^^^^^^^^^^^^^^^^^^^^^^^^
982 * If a filter is in effect in the Library Settings Editor,
983 the filter will continue to be applied after a user
984 changes the selected library.
985 * Copy templates used for serials now correctly link to age
986 protection rules and MARC item type values (for the
987 "Circ as Type" field). During upgrade, the database update
988 will set to NULL any age protection and circ as type fields
989 in serial copy templates that do not point to defined values.
994 Obsolete Internal Flag Removed
995 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
997 An obsolete and unused `ingest.disable_metabib_field_entry` internal
998 flag was removed from the `config.internal_flags` table. It was
999 rendered obsolete by the addition of the 3 flags to control the
1000 browse, search, and facet indexing.
1005 Tweaks to Caching/Expiry of Public Catalog Assets
1006 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1007 The default cache expiration time for static assets (e.g.,
1008 CSS, image, and JavaScript files) in the public catalog and
1009 the Kid's PAC has been increased to one year. Links to all
1010 such assets now have a cache-busting value tacked on as a
1011 query parameter. This value is refreshed when `autogen.sh` is
1012 run, but it can also be manually set by adjusting the
1013 `ctx.cache_key` Template Toolkit variable.
1018 Action/Trigger Events Data Purging
1019 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1021 Action/Trigger event definitions have a new field called 'Retention
1022 Interval'. When an optional interval value is applied, events and
1023 template output data linked to the event definition will be deleted
1024 from the database once they reach the specified age.
1026 Retention Interval Restrictions for Passive Hooks
1027 +++++++++++++++++++++++++++++++++++++++++++++++++
1029 Restrictions are placed on retention interval values for event definitions
1030 using passive hooks to prevent data from being deleted while it's still
1031 needed by the system.
1033 The presence of event data is how the system knows not to send duplicate
1034 events. As long as a scenario exists where a duplicate event may be
1035 generated, the events must be retained.
1037 To apply a retention interval value to a passive-hook event definition:
1039 * The event definition must have a max_delay value.
1040 * The retention interval must be larger than the difference between
1041 the `delay` and `max_delay` values.
1043 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1044 interval must be greater than 3 days to ensure no duplicate events are
1045 created between the first event on day 7 and the end of the event validity
1051 A new `purge_at_events.sh` script is installed in the bin directory
1052 (typically `/openils/bin`) which should be added to CRON for regular
1055 NOTE: On large data sets, this script can take a long time to run and
1056 create higher than normal I/O load as it churns though the event and
1057 event_output tables. You may wish to run the script by hand the first
1058 time so it can be monitored. It can be run in psql like so:
1061 ---------------------------------------------------------------
1062 SELECT action_trigger.purge_events();
1063 ---------------------------------------------------------------
1065 NOTE: On *very* large data sets (10s to 100s of millions of event and
1066 event_output rows), it may be advisable to first repopulate the `event`
1067 and `event_output` tables with only the desired data before starting
1068 regular purges. This can be done, for example, using the copy to temp
1069 table, truncate source table, repopulate source table from temp table
1070 approach. This will be much faster than the `purge_events()` function
1071 in cases where most of the data will be purged.
1076 A number of `action_trigger.hook` entries which have always been treated
1077 as active hooks, though are configured as passive hooks, have been
1078 updated to properly reflect the non-passive-ness. This allows for
1079 simpler configuration of their retention interval values.
1085 Remove JSPAC Redirects
1086 ^^^^^^^^^^^^^^^^^^^^^^
1087 Future versions of Evergreen will no longer contain automatic redirects
1088 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1089 that the JSPAC is no longer supported. Existing sites, however, may
1090 wish to retain JSPAC redirects in their Apache configuration files since
1091 JSPAC URLs may still be used in the wild to access their catalogs.
1093 The original JSPAC URL redirects are all retained in the file
1094 `Open-ILS/examples/jspac_redirects.conf` for reference.
1104 New open-ils.auth.login API
1105 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1106 The `open-ils.auth` service has a new API for requesting an authentication
1107 token. It performs the same steps as the
1108 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1109 using the bare password. No intermediate password hashing is required.
1111 The paramaters are the same as the `.complete` call with a few modifications.
1113 1. Using the generic 'identifier' parameter in combination with the
1114 'org' parameter allows the API to reliably determine if an identifier
1115 value is a username or barcode. The caller is no longer required to
1116 make that determination up front.
1118 2. The 'nonce' parameter is no longer used.
1124 Batch Patron Contact Invalidation
1125 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1126 The following methods are used to mark patron contact fields
1127 as invalid by moving the invalid value to a standing penalty:
1129 * `open-ils.actor.invalidate.email`
1130 * `open-ils.actor.invalidate.day_phone`
1131 * `open-ils.actor.invalidate.evening_phone`
1132 * `open-ils.actor.invalidate.other_phone`
1134 These methods now accept a fifth argument specifying the value
1135 of the contact field, e.g., a specific phone number or email
1136 address. If supplied, and if a specific patron ID (the first
1137 argument) is not supplied, all patrons with that specific contact
1138 value will have it marked invalid.
1148 Pure-SQL catalog searching
1149 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1150 Public and staff catalog search is now both more accurate and faster
1151 by redesigning how the visibility of records is calculated.
1161 Authority Record and Headings Browse Improvements
1162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1163 Various improvements are made to support for authority records
1164 and headings browsing:
1166 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1167 headings from authority records. Since the MODS and MADS stylesheets
1168 extract headings in similar ways, duplicate browse entries are now
1169 much less likely to occur.
1170 * A new configuration table, `authority.heading_field`, is now used
1171 to specify how headings should be extracted from authority records.
1172 * Related headings can now be identified as narrower or broader when
1173 browsing in the public catalog.
1174 * See references are now more reliably included in the browse list.
1175 * Scope (public) notes now display only under the main heading.
1176 * There is now a global flag, Display related headings (see-also) in browse,
1177 that can be used to control whether related headings (see-alsos) are
1178 displayed in the public catalog list.
1179 * A complete set of thesauruses are now included in the seed data. Thesauruses
1180 can now be identified using short and long codes.
1181 * The labels for see and see-also references in the public catalog are
1182 a bit more patron-friendly, and can now be tweaked via TPAC template
1183 customization in the browse.tt2 file.
1189 Copy Tags and Digital Bookplates
1190 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1191 Copy tags will allow staff to apply custom, pre-defined labels or tags
1192 to copies. Copy tags are searchable in both the staff client and public
1193 catalog. This feature was designed to be used for Digital Bookplates to
1194 attach donation or memorial information to copies, but may be used for
1195 broader purposes to tag items.
1197 Each copy tag can either be publicly-visible or visible only to staff.
1198 Copy tags also have types that can be used for restricting catalog
1199 searches on copy tags to particular types.
1201 Copy tags are displayed in the copy table in the record summary page in
1202 the public catalog, and a new library setting can be used to add
1203 a "Digital Bookplate" search field. Copy tags can also be used
1204 as a search filter, e.g.,
1206 * `copy_tag(bookplate, jane smith)`: search for records that have a
1207 copy tag of type 'bookplate' whose value contains 'jane smith'.
1208 * `copy_tag(*, jane smith)`: search for records that have a
1209 copy tag of any type whose value contains 'jane smith'.
1211 All staff-side interfaces related to copy tags exist only in the web
1212 staff client. There are two new administration interfaces for managing
1213 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1214 button for applying copy tags to copies; that interface can also be
1215 used to create new copy tags on the fly. Furthermore, the copy buckets
1216 interface now has an 'Apply Tags' action for assigning tags to groups
1222 Two new permission are included:
1224 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1225 'Administration -> Server Administration -> Copy Tag Types'
1226 * `ADMIN_COPY_TAG`: required to create a new tag under
1227 'Administration -> Local Administration -> Copy Tags'
1229 The existing permission `UPDATE_COPY` controls whether or not a user
1230 can link copies to tags.
1234 A new library setting, 'Enable Digital Bookplate Search', controls
1235 whether to display a 'Digital Bookplate' field in the search index
1236 drop-downs in the catalog. A 'Digital Bookplate' search will include
1237 all records that have a copy that matches the tag specified by the user.
1238 It should be noted that this library setting does not affect the
1239 display of copy tags on the catalog record summary page.
1244 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1246 The call number prefix and suffix, when present, are now included in
1247 subfields $k and $m of the 852 field when running `marc_export` with
1248 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1249 server configured to embed item data in 852 fields, the affixes are now
1250 included in subfields $k and $m.
1260 Batch Editing of Patron Records
1261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1262 There is a now a new interface analogous to the Copy Bucket interface
1263 to select and group a set of users into a User Bucket.
1264 The addition of users to a User Bucket is possible from the Patron Search
1265 interface by the use of a new grid Action, and directly on the User Bucket
1266 interface by user barcode. It is also possible to add users to a User
1267 Bucket by uploading a text file that contains a list of user barcodes.
1269 From this interface it is possible to perform a set of specific batch update
1270 operations on user records.
1275 These fields can now be changed in batch via an action on the User Bucket
1276 grid if the staff user has the `UPDATE_USER` permission:
1279 * Primary Permission Group (group application permissions consulted)
1281 * Home Library (`UPDATE_USER` checked against both old and new value)
1282 * Privilege Expiration Date
1283 * Barred flag (`BAR_PATRON` permission consulted)
1284 * Internet Access Level
1286 Changes made in this interface can be rolled back.
1288 As a batch process, rather than a direct edit, this mechanism explicitly skips
1289 processing of Action/Trigger event definitions for user update.
1294 The batch edit mechanism also allows for the batch deletion of user. The staff
1295 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1297 Changes made in this interface can be rolled back.
1299 As a batch process, rather than a direct edit, this mechanism explicitly skips
1300 processing of Action/Trigger event definitions for user deletion.
1302 This mechanism does not use the Purge User functionality, but instead simply
1303 marks the users as deleted.
1305 Editing Statistical Category Entries
1306 ++++++++++++++++++++++++++++++++++++
1308 All users in the bucket can have their Statistical Category Entries
1309 modified. Unlike user data field updates, modification of Statistical
1310 Category Entries is permanent and cannot be rolled back.
1312 As a batch process, rather than a direct edit, this mechanism explicitly skips
1313 processing of Action/Trigger event definitions for user update.
1315 New Service Requirement
1316 +++++++++++++++++++++++
1318 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1319 unused in production. If this service has been removed from the configuration
1320 of a live Evergreen instances, it will need to be added back in order for
1321 batch user editing to succeed.
1326 Honor Timezone of the Acting Library
1327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1332 * Display day-granular due dates in the circulating library's timezone.
1333 * Only display the date portion of the due date for day-granular circulations.
1334 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1335 * Provide infrastructure for more advanced formatting of timestamps.
1336 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1341 This is a followup to the work done for 2.12, where we added the ability
1342 for the client to specify a timezone in which timestamps should be interpreted
1343 in business logic and the database.
1345 Most specifically, this work focuses on circulation due dates and the closed
1346 date editor. Due dates, where displayed using stock templates (including
1347 receipt templates) and used for fine calculation, are now manipulated in the
1348 library's configured timezone. This is controlled by the new 'lib.timezone'
1349 setting available via the Library Settings Editor, loaded from the server when
1350 required. Additionally, closings are recorded in the library's timezone so that
1351 due date calculation is more accurate. The closed date editor is also
1352 taught how to display closings in the
1353 closed library's timezone. Closed date entries also explicitly record if they
1354 are a full day closing, or a multi-day closing. This significantly simplifies
1355 the editor, and may be useful in other contexts.
1357 To accomplish this, we use the moment.js library and the moment-timezone addon.
1358 This is necessary because the stock AngularJS date filter does not understand
1359 locale-aware timezone values, which are required to support DST. A simple
1360 mapper translates the differences in format values from AngularJS date to
1363 Of special note are a set of new filters used for formatting timestamps under
1364 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1365 filters provide the functionality, and autogrid is enhanced to make use of
1366 these where applicable. egGrid and egGridField are also taught to accept
1367 default and field-specific options for applying date filters. These filters may
1368 be useful in other or related contexts.
1370 The egDueDate filter, used for all existing displays of due date via Angular
1371 code, intentionally interprets timestamps in two different ways WRT timezone,
1372 based on the circulation duration. If the duration is day-granular (that is,
1373 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1374 of seconds) then the date is interpreted as being in the circulation library's
1375 timezone. If it is an hourly loan (any duration that does not meet the
1376 day-granular criterium) then it is instead displayed in the client's timezone,
1377 just as all other timestamps currently are, because of the previous Evergreen
1380 The public catalog is adjusted to always display the due date in the circulating
1381 library's timezone. Because the public catalog displays only the date portion of the due
1382 date field, this difference is currently considered acceptable. If this proves
1383 to be a problem in the future, a minor adjustment can be made to match the
1384 egDueDate filter logic.
1386 Now that due dates are globally stored in the configured timezone of the
1387 circulating library, the automatic adjustment to day-granular due dates needs
1388 to take those timezones into account.
1390 An optional SQL command is provided by the upgrade script to retroactively
1391 adjust existing due dates after library configuration is complete.
1397 Enhancements to Hard Due Date Functionality
1398 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1399 It will now be possible to delete Hard Due Date Values for dates that have
1400 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1401 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1402 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1407 Patron Search by Birth Date
1408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1409 * Now you can include the patron birth year and/or birth month and/or
1410 birth day when searching for patrons using the web staff client.
1411 * Day and month values are exact matches. E.g. month "1" (or "01")
1412 matches January, "12" matches December.
1413 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1414 1915, 1599, etc. For exact matches use the full 4-digit year.
1418 Patron Search from Place Hold
1419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1420 This feature allows staff members, when placing a
1421 hold on behalf of a patron in the web staff client, to search for
1422 patrons by names and other searchable patron information, rather than
1423 relying on barcode alone. In particular, after performing a catalog
1424 search or going to a specific bib record and clicking the 'Place Hold'
1425 button, the form now includes a 'Patron Search' button. This button
1426 will open a dialog allowing the staff member search for and select
1432 Retrieve Recent Patrons
1433 ^^^^^^^^^^^^^^^^^^^^^^^
1435 Adds a new library setting 'Number of Retrievable Recent Patrons'
1436 ('ui.staff.max_recent_patrons') that specifies the number of recently
1437 retrieved patrons that can be re-fetched from the staff client.
1439 A value of 0 means no recent patrons can be retrieved.
1440 A value greater than 1 means staff will be able to retrieve multiple
1441 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1443 The default value is 1 for backwards compatibility.
1450 Fuller title in XUL client Simplified Pull List
1451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1452 The Simplified Pull List in the XUL client will now display subfields 245$n and
1453 $p in the title field. The addition will make it easier for staff to distinguish
1454 between different parts or seasons in a series.
1460 Transit Cancel Time and Terminology Change
1461 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1466 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1467 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1468 are preserved in the database, though still not visible to the end user in the staff client.
1469 This allows for better tracking of when transits are canceled for the purposes of knowing
1470 which staff member canceled the transit, etc.
1472 NOTE: This change may require the re-creation of transit reports to filter out canceled
1473 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1474 Is NULL' will suffice.
1476 "Canceled Transit" Terminology Change
1477 +++++++++++++++++++++++++++++++++++++
1479 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1480 For internal continuity, however, the following permission codes have not changed:
1483 * `ABORT_REMOTE_TRANSIT`
1484 * `ABORT_TRANSIT_ON_LOST`
1485 * `ABORT_TRANSIT_ON_MISSING`
1493 Offline Circulation Available in Web Staff Client
1494 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1495 Offline circulation is now available in the web staff client. In order to use the
1496 offline interface, users must first log into the web staff client, perform
1497 a patron search, select a user from the results, and open the patron editor
1498 interface to collect all the relevent configuration information for the
1499 workstation. In addition, the offline interface available from the Circulation
1500 menu provides a 'Download block list' button for users who are logged in.
1502 As is the case in the old staff client, users can check materials in and out,
1503 renew items, and create new patron accounts while offline. The patron fields
1504 available in the offline patron registration editor are the same ones that
1505 are available to staff when working online.
1509 Add Circ Modifier to Record Detail Page in Staff TPAC
1510 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1511 The circulation modifier field is added to the table of copies to make
1512 more information available to staff without having to open
1519 Date+Time Format Settings for Web Client
1520 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1522 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1523 and adds two settings for use with the webstaff client:
1525 * 'Format Dates with this pattern'
1526 * 'Format Date+Time with this pattern'
1528 These settings use format strings as documented here:
1530 https://docs.angularjs.org/api/ng/filter/date
1532 There is overlap with how the Dojo formats worked, but also some differences.
1534 The original 'Format Dates' and 'Format Times' settings worked together, but the
1535 new settings work independently. Certain field elements will use one, and
1536 certain field elements will use the other. These distinctions are hard-coded
1537 in the various UI templates, with the idea being that timestamp fields in
1538 which the date component alone is sufficient information (for example, date of birth)
1539 will use the 'Format Dates' setting. Fields where the time component is
1540 important (for example, checkout time) will use the 'Format Date+Time' setting.
1542 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1543 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1549 Global Option to Remove Sound for a Specific Event
1550 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1551 A new `nosound.wav` file has been added to the web client. The file can be used
1552 to globally disable audio alerts for a specific event on an Evergreen system.
1554 For example, to silence the alert that sounds after a successful patron search:
1558 mkdir -p /openils/var/web/audio/notifications/success/patron/
1559 cd /openils/var/web/audio/notifications/success/patron/
1560 ln -s ../../nosound.wav by_search.wav
1567 The official Evergreen manual has been split into eight new manuals, each
1568 designed for a specific audience. This new approach is designed to make
1569 the documentation more readable and usable.
1571 The specific audiences for the new manuals are:
1573 * Acquisitions staff
1576 * Public services staff who use the public catalog
1578 * System administrators who use the command line
1579 * System administrators who use the Web client
1580 * System administrators and programmers who wish to integrate Evergreen
1581 with other technologies
1583 All manuals are available at http://docs.evergreen-ils.org
1589 Improvements to ebook API
1590 ^^^^^^^^^^^^^^^^^^^^^^^^^
1592 Evergreen now supports checking out and placing holds on
1593 OverDrive and OneClickdigital ebook titles from within the public
1594 catalog. This is an experimental feature. It is not recommended for production
1595 use without careful testing.
1597 When ebook integration is enabled, a "Check Out E-Item" link will be
1598 displayed when viewing an ebook title from a supported vendor in the
1599 catalog. Clicking on the link allows the user to check out and download
1600 that title from the vendor directly within the catalog.
1602 If no copies are available for the title, a "Place Hold on E-Item" link
1603 is displayed instead, and the user may place a hold on the title. (Note
1604 that some vendors require the user's account to have an email address
1605 before permitting a hold.)
1607 My Account includes the ability to view current ebook checkouts and
1608 holds, download already-checked-out titles, and cancel holds.
1610 For API integration to work, you need to request API access from the
1611 vendor, and the vendor must have a way of authenticating your patrons.
1612 Your Evergreen system also needs to be configured for ebook API
1613 integration, following the instructions in the command line system
1614 administration manual
1617 This feature assumes that you are importing MARC records supplied by the
1618 vendor into your Evergreen system, using Vandelay or some other MARC
1619 import method. This feature does not search the vendor's online
1620 collections or automatically import vendor records into your system; it
1621 merely augments records that are already in Evergreen.
1623 Improvements to Bill Payment Pages
1624 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1625 The bill payment pages in the public catalog have been revamped
1628 * use the term "charges" instead of "fees"
1629 * include images of credit cards accepted
1630 * make the default print receipt template match other itemized receipts;
1631 note that this change is not automatically applied when upgrading.
1632 * display billing type
1633 * add button to pay only selected charges
1634 * reformat the credit card number input page
1640 Clickable Copy Locations
1641 ^^^^^^^^^^^^^^^^^^^^^^^^
1642 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1643 the associated copy location will display as a link in the public catalog summary display.
1644 This link can be useful for retrieving maps or other directions to the copy
1645 location to aid users in finding material.
1650 Download Checkout History CSV Fixed for Large Number of Circulations
1651 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1652 Downloading checkout history as a CSV from My Account has been fixed
1653 for users with a large circulation history. Previously, this would
1654 time out for patrons with more than 100 or so circulations.
1656 This feature no longer uses the action/trigger mechanism and the public catalog
1657 now generates the CSV directly. The old action/trigger code is still
1658 present in the database and should be removed at some point in the
1664 Google Books Preview Rewrite
1665 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1666 The Google Books Preview functionality in record detail pages has been
1667 rewritten to modernize its style and optimize its performance:
1669 * The Dojo JavaScript framework is no longer used, saving approximately
1670 150K of JavaScript and CSS and four network requests per page load.
1671 * The Embedded Viewer is not loaded unless a possible preview is found,
1672 saving more network and memory overhead.
1673 * The Google Books Loader is used to load the Embedded Viewer instead of the
1674 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1676 * All variables are self-contained and do not pollute the global namespace.
1677 * Event listeners are registered to handle clicks, rather than attaching
1678 `href="javascript:function()"` to <a> elements.
1679 * Book previews are displayed in a panel sized according to the viewport
1680 of the browser, improving its appearance on both mobile and desktop
1682 * The rewritten code is now served up directly from
1683 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1688 jQuery for the Public Catalog
1689 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1690 This release adds optional support for jQuery in the public catalog. This support
1691 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1692 `config.tt2` template.
1698 New Popularity Parameters
1699 ^^^^^^^^^^^^^^^^^^^^^^^^^
1700 New popularity parameters for in-house use over time and for count of distinct
1701 organizational units that own a title are now available. Evergreen sites
1702 can use these parameters to create new statistical popularity badges for
1703 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1705 The in-house use parameters will apply a badge to titles that have the most
1706 in-house use activity over time. The organizational unit count parameter
1707 will apply a badge to titles owned by the most number of libraries in a
1708 consortium. Ownership is determined by the copy's circulation library.
1713 Option to Suspend Holds at the Time They are Placed
1714 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1715 Users now have the option to suspend a hold at the same time they place the
1716 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1717 who want to suspend a hold at the time it is placed. There is also an option
1718 to set the activation date at the same time. This option is also available
1719 when placing holds on a batch of titles from 'My List' and will apply to
1720 all the titles in the batch.
1731 Fix to reporter.classic_current_circ View
1732 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1733 The `reporter.classic_current_circ` view, which is part of some
1734 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1735 has been fixed to not exclude loans for patrons who do not have a
1736 billing address set. Users of this view should rerun
1737 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1742 New Report Source Table Allowing Report of "Last" Deleted copy
1743 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1745 This source table allows you to construct a clever aggregate report template
1746 which will report bibliographic IDs where a library or a group of libraries
1747 no longer have a copy attached but *had* a copy attached. This is especially
1748 useful when a holdings sync is required with an external vendor.
1751 Instructions for creating a report template with this source:
1753 * Create a new report template using "Library Holdings Count with Deleted" as the source
1754 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1755 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1756 * 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"
1757 * Add "Bib ID" to Displayed Fields
1758 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1759 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1760 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1763 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1764 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1765 specified date range. Unfortunately the user will have to manually type the date range without the date
1766 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1767 copy and more than two deleted copies."
1772 Add Provider to Provider Note Link
1773 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1774 The Provider reporting source now includes a link to the Provider Note reporting source.
1779 Link ILS User and Working Location Reporting Sources
1780 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1781 The Working Location reporting source now has labels
1782 and it is now linked to the ILS User reporting source, allowing
1783 reports to display or filter on staff working location.
1788 New Circulation Report Source "All Circulation Combined Types"
1789 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1791 This report source will allow you to create a single report template for all of the following:
1794 * In-house uses of non-cataloged items
1796 * Circulations of non-cataloged items
1798 To distinguish between these different types of library use, it's important to display these columns
1799 in your report templates:
1808 Reports Template Searching
1809 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1810 A new form appears along the top of the reports interface for searching
1811 report templates. Once found, typical template actions (e.g. create new
1812 report) are available from within the results interface.
1814 Searches may be performed across selected (visible) folders or all
1815 folders visible to the logged in user.
1817 Searches are case-insensitive, any word order, with left-anchored words.
1818 All searched words must appear in at least one of the searched fields.
1823 * Searching for 'stat cat' matches:
1825 ** statistical category
1826 ** categories, statistical
1827 ** patrons (stat cat)
1828 * Searching for 'stat cat' does not match:
1830 *** both words must be present in the searched field(s)
1832 *** location contains 'cat' but it's not left-anchored.
1837 The templates, reports, and output interfaces now support paging via
1838 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1850 Web Staff Client Serials Module
1851 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1852 The serials module has been ported over to the web staff
1853 client, implementing a unified serials interface that combines
1854 ideas from both the serial control view and alternate serials
1855 control view from the old staff client.
1857 In addition to carrying over functionality that was available
1858 in the old staff client, several new features are included:
1860 * the ability to save prediction pattern codes as templates
1861 that can be shared and reused within an Evergreen database
1862 * a more streamlined interface for managing subscriptions,
1863 distributions, and streams
1864 * it is no longer necessary to create a starting issue in
1865 order to predict a run of issues; the dialog box for
1866 generating a set of predicted issues now lets you specify
1867 the starting point directly.
1868 * the ability to more directly edit MFHDs
1870 The new serials interfaces can be accessed from the record
1871 details page via a Serials drop-down button that links to
1872 a subscription management page, a quick-receive action, and
1873 a MFHD management page. There is also a new 'Serials Administration'
1874 page where prediction pattern and serial copy templates can
1885 SIP Bugfix Changes How Encoding Is Determined in Configuration
1886 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1888 The combined fix for the above mentioned SIP bugs alters the way that
1889 SIPServer looks up the output encoding in the configuration file (typically
1890 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1893 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1894 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1895 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.
1896 4. If none of the above exist, then the default encoding (ASCII) is used.
1898 Number 3 is provided to ease the transition to the new code. It is
1899 the current location of the +encoding+ element in the sample
1900 configuration file and as such, where it is likely to be found in
1901 actual files. It is recommended that you alter your configuration to
1902 move this element out of the +implementation_config+ element and into
1903 its parent +institution+ element. Ideally, SIPServer should *not* look into
1904 the implementation config, and this check may be removed at some time
1912 Web Client Acknowledgments
1913 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1915 The project to develop a new browser-based web client launched four
1916 years ago at the September 2013 Evergreen developer hack-a-way when the
1917 developer community voted to move away from the XUL client and explore other
1918 platforms. The first web client preview became available in Evergreen 2.7 when
1919 circulation was available in the new platform.
1921 The browser-based client is available due to the work of many coders, testers,
1922 bug reporters, documentors, translators, project managers, spec writers, funders
1923 and other contributors over the past four years.
1925 The Evergreen project would like to acknowledge the following organizations
1926 that funded development of the Web Staff Client:
1929 * British Columbia Libraries Cooperative
1930 * Consortium of Ohio Libraries
1932 * Georgia Public Library Service
1933 * Grand Rapids Public Library
1935 * Kenton County Public Library
1936 * King County Library System
1939 * Pennsylvania Integrated Library System
1940 * Pioneer Library System
1943 The Evergreen project would also like to thank the following individuals who
1944 contributed code, translations, documentation patches, tests, bug reports,
1945 technical specifications, and project management to the Web Staff Client:
1982 * Freddy Enrique Pelayo Huapalla
2008 Evergreen 3.0 Acknowledgments
2009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2011 The Evergreen project would like to acknowledge the following
2012 organizations that commissioned developments in this release of
2016 * British Columbia Libraries Cooperative (BC Sitka)
2018 * Georgia Public Library Service
2019 * King County Library System
2021 * Pennsylvania Integrated Library System
2022 * Pioneer Library System
2024 We would also like to thank the following individuals who contributed
2025 code, translations, documentation patches, and tests to this release of
2074 We also thank the following organizations whose employees contributed
2077 * British Columba Libraries Cooperative
2081 * Emerald Data Networks, Inc.
2082 * Equinox Open Library Initiative
2084 * Grand Rapids Public Library
2085 * Indiana State Library
2087 * King County Library System
2088 * Lake Agassiz Regional Library
2089 * Laurentian University
2090 * Linn-Benton Community College
2092 * Merrimack Valley Library Consortium
2094 * North of Boston Library Exchange
2095 * Pennsylvania Integrated Library System
2096 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2098 * Traverse Area District Library
2100 We regret any omissions. If a contributor has been inadvertently
2101 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob