1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.8. Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
14 * Fixes specific cases in which deleted records appear in search results.
15 * Fixes a performance issue with deleting patrons.
16 * The hold shelf dialog popup now lists the patron's notification
18 * Fixes an issue that prevented editing items when a monograph part
20 * Patron information is now available for use in the bills_current
21 and bills_historical receipt templates.
22 * The browser's "This page may contain unsaved data" warning now
23 appears when users click the update
24 expire date button in a patron account and attempt to navigate away
26 * The holds tab of the patron record now includes a monograph part
28 * The barcode box in the checkout screen
29 no longer hovers above patron record tabs when
30 staff users scroll down.
31 * Fixes an issue with the date of birth in the patron edit scren.
32 * Fixes an issue with the dropdown of billing type options.
33 * The Item Status screen now includes as a floating group column.
37 We would like to thank the following individuals who contributed code,
38 tests and documentation patches to the 3.0.9 point release of
41 * BC Libraries Cooperative
47 * Blake Graham-Henderson
64 This release contains bug fixes improving on Evergreen 3.0.7. Note that
65 all bug fixes refer to the web staff client unless otherwise specified.
73 * The MARC editor now handles 008 fields better.
74 * Adds spaces between subfields when suggesting a call
75 number for a new volume.
76 * MarcXML exports from the MARC Batch Import/Export ->
77 Export Records screen now downloads the file, rather than opening
79 * The Item Status Circulation Library column now displays a
80 shortname rather than the full library name.
81 * The Item Status Remaining Renewals column now displays
83 * The Item Status now has a "Last Renewal Workstation" column
85 * Fixes the circulation counts displayed in Item Status Details.
86 * Fixes an issue where multiple copies with different values for required
87 statistical categories could not be edited and saved in batch.
88 * Add an option to remove floating in the copy editor.
89 * Fixes an issue with the floating dropdown in the copy editor.
90 * Fixes a problem in which the copy template didn't properly copy
92 * Reduces the number of API calls that the MARC Editor requires.
97 * Fixes an issue that prevented the offline patron registration
99 * Fixes an issue with searching patrons by permission group.
100 * The barcodes in the patron search are now clickable.
101 * Staff members can now manually override the patron juvenile
102 flag value, regardless of the patron's date of birth.
103 * Checkboxes on patron registration screen are now properly aligned
105 * The user permission group dropdowns in the patron registration,
106 edit, and search interfaces now have scrollbars.
107 * The date picker on the checkout screen is now hidden unless
108 circ staff activates a specific due date option.
109 * The check-in screen now includes a copy status column.
110 * The Merge Patrons interface now displays the date of birth.
111 * The user bucket screen now displays the Bucket ID.
112 * The payment button on patron bills screen is now inactive if the
113 Payment Received field is blank.
114 * The Bill History receipt now includes a Finish date and a Last
116 * When a patron summary contains an image of the patron,
117 that image tag now has a null alt attribute to remove it from
118 the flow of a screen reader.
119 * Corrects an issue that caused the transit dialog to show the
121 * Corrects an issue with printing transit lists.
122 * "Find another target" on transiting hold no longer leaves the
124 * The images now display to distinguish hold and transit slips.
125 * The Clearable Holds list printout now only shows holds that have
127 * Restores the call number prefix and suffix fields to the holds
129 * The documentation at the top of the hold shelf slip template
131 * The cursor in the in-house use screen now automatically goes
132 to the barcode field.
133 * The in-house use screen now shows a copy status column.
134 * Add support for converting change to patron credit in the patron bills
135 interface, consistent with the XUL feature.
136 * Fixes a bug that caused pickup/request library fields to be
138 * Fixes a bug in the offline org unit tree.
140 Command-line system administration
141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143 * The novelist entry in `eg_vhost.conf` includes two new
145 * Corrects an issue with the `--max-sleep` argument on the
146 `action_trigger_runner.pl` support script.
147 * Corrects an issue with how the `eg_pbx_allocator.pl` script
148 detects an existing lock file.
149 * The 3.0.2-3.0.3 upgrade script disables triggers before
150 recalculating bib visibility.
155 * Fixes an issue that caused records with located URIs to be
156 retrieved in Copy Location and Copy Location Group searches.
157 * Fixes an error message that appeared in the search box
158 in the public catalog while placing hold after an advanced search.
159 * Restores the display of copy information for the user's
160 preferred library in the public catalog.
161 * Fixes regression errors in the search results page.
162 * Removes redundant call numbers from the Show More Details
164 * The cast field in the catalog is now taken from the 511 field
165 when first indicator = 1, rather than the 508.
166 * Fixes a display issue caused by editing holds.
171 * Fixes an issue that prevented users from searching for
172 receivable issues using Database ID or ISSN in the Serials
173 Batch Receive interface.
178 * Adds some padding to the bottom of Web Client interfaces.
179 * Logins now honor all org unit timeout settings.
180 * Evergreen will now identify and handle invalid timezones.
181 * Fixes an issue where a column header in some interfaces were automatically
182 highlighted in green when retrieving the interface.
183 * The parts column in the Item Status screen now displays parts data.
189 We would like to thank the following individuals who contributed code,
190 tests and documentation patches to the 3.0.8 point release of
225 This release contains bug fixes improving on Evergreen 3.0.6.
227 * Fixes a performance issue with the Patron Billing History screen and
228 other screens that cause Flattener.pm to re-create joins
230 * Fixes an issue that prevented patron alerts from showing to staff at
232 * Corrects the "Holdable" attribute display on the Item Status detailed
234 * Fixes the ability to delete multiple copies from Item Status.
238 We would like to thank the following individuals who contributed code,
239 tests and documentation patches to the 3.0.7 point release of
253 This release is a security release that fixes cross-site scripting
254 (XSS) vulnerabilities in the Evergreen public catalog. This release
255 also includes several other bugfixes improving on Evergreen 3.0.5.
257 Security Issue: XSS Vulnerability in Public Catalog
258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 This release fixes several cross-site scripting (XSS) vulnerabilities
260 in the public catalog. When upgrading, Evergreen administrators should
261 review whether any of the following templates have been customized
262 or overridden. If so, either the template should be replaced with the
263 stock version or the XSS fix (which entails adding the `| html` filter
264 in several places) applied to the customized version.
266 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
267 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
268 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
270 Note that exploiting the XSS vulnerabilities fixed in this release
271 would require either the ability to create maliciously-constructed
272 MARC bibliographic or holdings records or the ability to set a
273 maliciously constructed organizational unit name.
277 Evergreen 3.0.6 also includes the following changes:
279 * When using 'Selection Lists -> Edit MARC Order Record' in the web
280 staff client, now only one click is required to save the MARC
281 record rather than two.
282 * The volume/copy editor in the web staff client now better handles
283 editing multiple items that have different sets of statistical
284 category values assigned to them.
285 * The act of merging bibliographic records now updates bookbags
286 that referred to the source bibliographic record rather than
287 effectively deleting entries for that record.
288 * Additional columns were added to the Holds Pull List in the
290 * The patron registration form in the web staff client now correctly
291 manages setting user preferences.
292 * An error in a pgTAP unit test was corrected.
296 We would like to thank the following individuals who contributed code,
297 tests and documentation patches to the 3.0.6 security release of
313 This release contains bug fixes improving on Evergreen 3.0.4.
315 * The MARC Editor in the Web staff client now wraps long fields.
316 * The MARC Editor no longer allows catalogers to enter new lines
318 * Fixes an issue that prevented serials items from being deleted or
320 * The Web staff client Check In screen no longer reloads the whole
321 page multiple times each time an item is scanned.
322 * Fixes an issue that displayed the oldest -- rather than the newest
323 -- transit in the Web staff client Item Status page.
324 * Fixes an issue that prevented the reports module from being displayed
326 * Fixes an issue in the Web staff client reports module that caused
327 syntax errors in reports that use virtual fields and joins.
328 * Fixes an issue that prevented several dropdown menus in the Web staff
329 client from activating.
330 * Fixes an issue that created duplicate copy data when copies or
331 volumes with parts were transferred.
332 * Fixes the Trim List feature in the Web staff client Check In screen.
333 * The Item Status grid now displays the Circulation Modifier.
334 * Restores missing data from the Profile column in Place Hold patron
336 * Fixes an issue with the http -> https redirect on Apache 2.4.
337 * Fixes an color contrast accessibility issue in the Web staff
338 client and adds underlining to links in grid cells for added accessibility.
339 * Adds automated regression and unit tests for the Web staff client
341 * Adds a process for spell-checking the official documentation.
342 * Adds a script that simplifies the release process related to translations.
347 We would like to thank the following individuals who contributed code,
348 tests and documentation patches to the 3.0.5 point release of
353 * Blake Graham-Henderson
368 This release contains bug fixes improving on Evergreen 3.0.3:
370 * Fixes a bug that caused all searches limited by shelving location to
372 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
373 rather than the ordering agency's SAN.
374 * Fixes a bug that prevented Safari/iOS users from logging in to the
376 * Fixes a bug that prevented users from using the browse interface.
377 * Fixes a bug in the Item Status List view that caused incorrect due
379 * Approval code is now a required field in the web client's patron
380 credit card payment form.
381 * Fixes a bug with credit card payments that caused a receipt to print
382 showing that the patron paid the bill when the payment had not actually
384 * Fixes a bug that prevented the EDI translator from being installed on
386 * Fixes a bug that caused entries to show up multiple times in the
387 Items Out and Holds tabs in the patron record.
388 * Fixes a bug that caused grids on Bills and Patron Messages
389 screens to not display properly.
390 * The following fields are now available for the Checkout and Items Out
397 ** money_summary.balance_owed
398 ** money_summary.total_paid
399 ** money_summary.total_owed
404 * The following fields are now available on the Bill Payment receipt templates:
414 * Payment type is now a column in the payments tab of the patron record
415 Bill History section.
416 * The "Replace Barcode" function now makes it more difficult for staff
417 members to attempt to create blank patron barcodes.
418 * The patron bills screen now prevents staff members from double-clicking
419 on the Apply Payment button (which otherwise would apply two payments).
420 * Fixes a bug that prevented patrons attached to statistical categories
421 from displaying in the patron search-to-hold dialog.
422 * Fixes a performance issue related to uploading CSV files of barcodes
423 to the item status and patron bucket interfaces.
424 * Fixes several small bugs in the Spanish translation.
425 * Fixes a performance bug related to patrons logging in by barcode.
429 We would like to thank the following individuals who contributed code,
430 tests and documentation patches to the 3.0.4 point release of
452 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
453 update the visibility attributes of all bibs that make use of Located URIs or
454 bib sources. It may take a while to run on large datasets. If it it running
455 too long, it can be canceled and the following psql commands will create and
456 run a script that will perform the same action serially over time without
457 blocking writes to bibs:
460 \o /tmp/luri_visibility_update.sql
461 SELECT 'UPDATE biblio.record_entry SET ' ||
462 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
463 'WHERE id = ' || id || '; SELECT ' || id || ';'
464 FROM biblio.record_entry
466 SELECT DISTINCT cn.record
467 FROM asset.call_number cn
469 AND cn.label = '##URI##'
472 FROM asset.uri_call_number_map m
473 WHERE m.call_number = cn.id
476 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
481 \i /tmp/luri_visibility_update.sql
484 It will output the id of each updated bib so that the script can be killed
485 and then edited to remove completed bibs. The remainder can be run at a
488 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
489 we do NOT update the bib's visibility attributes, as doing so causes a loop
490 and an eventual trigger stack violation. This flag should ONLY be used when
491 forcing reingest of record attributes (NOT visibility attributes), search,
492 facet, and display fields, so if using this flag under normal operation,
493 proceed at your own risk and know that Located URI and bib source changes
494 will not be reflected in the visibility attributes of the record.
498 This release contains several bug fixes improving on Evergreen 3.0.1:
500 * Fixes several issues related to the display of located URIs and records with
501 bib sources in search results.
502 * Setting `opac_visible` to false for a copy location group now hides only
503 the location group itself, rather than also hiding every single copy in the
505 * Fixes a bug that prevented the copy editor from displaying the _fine level_
506 and _loan duration_ fields.
507 * The "Edit Items" grid action in the Item Status interface will now open
508 in the combined volume/copy editor in batch. This makes the behavior
509 consistent with the "Edit Selected Items" grid action in the copy
511 * Staff members are now required to choose a billing type when creating a
512 bill on a user account.
513 * The Web client now provides staff users with an alert and option to
514 override when an item with the Lost and Paid status is checked in.
515 * Fixes a bug where the Web client offline circ interface was not able
516 to set its working location.
517 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
519 * The MARC editor in the Web staff client now presents bib sources in
521 * Both circulation and grocery bills are now printed when a staff user selects
522 a patron account and clicks "Print Bills".
523 * Fixes an issue in the XUL serials interface the "Receive move/selected"
524 action from succeeding.
525 * Fixes a typo in the user password testing interface.
529 We would like to thank the following individuals who contributed code,
530 tests and documentation patches to the 3.0.3 point release of
549 This release contains several bug fixes improving on Evergreen 3.0.1:
551 * Copy templates created in XUL Holdings Maintenance will now be
552 automatically converted and displayed in the web staff client's
554 * The list of report templates now includes a column indicating whether
555 the template was originally created in the XUL staff client or the web
556 staff client; staff need to know this since report templates created in
557 one interface cannot be edited in the other.
558 * Call number prefixes and suffixes are now displayed in various grids
559 in the web staff client, including
560 ** Pending Copy Buckets
562 ** Checkin/Capture Holds
564 ** Patron Bills History
571 ** Bib Record View Holds
573 * Many patron fields have been redacted from the web staff client's patron
574 and record holds grids, leaving patron name, username, and ID.
575 * Fixes two bugs where patron records could fail to be saved upon editing.
576 * The web staff patron editor now better warns staff users about
577 duplicate names, IDs, phone numbers, and email addresses.
578 * Human readable labels are now displayed for certain fields in standing
580 * The patron summary in the web staff client now correctly displays
581 primary and secondary ID values.
582 * The web staff client's billing full details page now displays
583 information about the staff user that created a payment.
584 * The web staff client now requires staff users to explicitly set a
585 billing type when adding a manual bill.
586 * The web staff client's patron bill annotation modal now works.
587 * Patron barcode search completion in the web staff client now allows
588 the user to select from all of the matching patron records.
589 * The Hold Shelf Slip print template in the web staff client now has
590 access to the call number.
591 * The Checkout Receipt print template in the web staff client now can
592 include summary financial information, incuding current balance, total
593 paid on outstanding fines, and total owed.
594 * The web staff print templates for current and historical bills can
595 now include copy barcode and title.
596 * Fixes a bug that resulted in some catalog searches unexpectedly
598 * Fixes a bug that resulted in catalog searches that specify a location
599 limit returning incorrect results.
600 * Fixes a bug where deleted copies could make records visible in the
602 * Fixes a bug where certain queries on copies used in the public catalog
604 * Fixes a bug place a hold request in the public catalog could result
605 in "forgetting" the type and library of the user's previous search.
606 * The web staff client now respects staff user session timeouts, and
607 will log out all open tabs if a user's session has timed out.
608 * The web staff Z39.50 page will now give the staff user an alert if
609 they attempt to import a record with a duplicate TCN.
610 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
611 entries from being deleted.
612 * Fixes a bug that made using the volume/copy editor to change a copy's
614 * The administration interface for hard due dates now ensures that
615 new (or edited) ceiling dates have their time component set to end
616 of day, resolving an issue where ceiling dates would not be applied
617 during the ceiling date itself.
618 * The web staff client can now include dynamic information in browser
619 tab titles, e.g., "Smith, Jane - Checkout".
620 * The Concerto sample data set now includes data allowing for testing
621 placing holds on monographic parts.
622 * Asset merging during bibliographic record merging now correctly
623 recognizes call number prefixes and suffixes and deletes disused
625 * Fixes a bug where displaying user surveys could result in PCRUD
627 * Fixes a bug where pg_restore of an Evergreen database could fail
628 to create certain indexes on the `actor.usr` table.
632 We would like to thank the following individuals who contributed code,
633 tests and documentation patches to the 3.0.2 point release of
664 This release contains several bug fixes improving on Evergreen 3.0.0
666 * Fixes a bug in the web staff client that prevented initials from being
667 stored with copy notes.
668 * Adds billing types that may have been missed by systems that were
669 running Evergreen prior to the 1.4 release.
670 * Fixes a web staff client bug with the CSV export option available from
671 the Import Queue in the MARC Batch Import/Export interface.
672 * Adds the missing copy alert field in the web client's volume/copy
674 * Fixes a bug where the setting to require date of birth in patron
675 registration was not being honored in the web staff client.
676 * Fixes a bug in the web staff client patron registration form where the
677 password wasn't generating from the last four digits of the patron's
679 * Fixes an issue in the web staff client where the complete barcode did
680 not display in some interfaces when partial barcodes were scanned.
681 * Fixes an HTML error in the new copy tags that display on the record
683 * Fixes a web staff client bug where recording a large number of in-house
684 uses at one time doesn't display a confirmation dialog once it hits the
686 * Adds a _Print Full Grid_ action in the web staff client
687 holds pull list to allow staff to print the entire pull list as it
688 displays on the screen. This change also changes the _Export CSV_ action
689 to an _Export Full CSV_ option.
690 * Fixes an issue with the Patron Messages interface that prevented it
691 from saving column configuration changes in the web staff client.
692 * Fixes a bug in the web staff client where a billing prompt did not
693 correctly display after marking an item damaged in those systems that
694 have enabled the setting to bill for damaged items.
695 * Adds an option to the specific due date feature that allows saving
696 that due date until logout. This allows all circulations from a given
697 workstation to be due on the same date.
701 We would like to thank the following individuals who contributed code,
702 tests and documentation patches to the 3.0.1 point release of
724 The minimum version of PostgreSQL required to run Evergreen 3.0 is
725 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
727 Change to Names of Shared Libraries
728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
729 OpenSRF 3.0 changes how the shared libraries for services written in
730 C are named. If upgrading from an earlier version of Evergreen,
731 `opensrf.xml` should be edited so that shared library file names
732 listed in the `<implementation>` tag start with "lib". For example,
735 ---------------------------------------------------------------------
737 <language>C</language>
738 <implementation>oils_cstore.so</implementation>
739 ---------------------------------------------------------------------
741 should be changed to:
744 ---------------------------------------------------------------------
746 <language>C</language>
747 <implementation>liboils_cstore.so</implementation>
748 ---------------------------------------------------------------------
750 SIP Bugfix Requires SIPServer Upgrade
751 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
753 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
754 crash" requires that you also upgrade SIPServer with the fix for
755 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
756 SIP client problems." This means that if you use SIP2 with Evergreen,
757 you must also upgrade SIPServer to the latest commit in the Git
758 repository. Conversely, if you upgrade SIPServer to the latest commit
759 in Git, you must also upgrade Evergreen or, at least, apply the patch
760 for Launchpad Bug 1542495. These two patches are complementary and
761 cannot be applied independently of one another.
763 `open-ils.auth.login`
764 ~~~~~~~~~~~~~~~~~~~~~
765 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
766 API's in the `opensrf_core.xml` file.
771 ---------------------------------------------------------------------
772 --- a/Open-ILS/examples/opensrf_core.xml.example
773 +++ b/Open-ILS/examples/opensrf_core.xml.example
774 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
776 <match_string>open-ils.auth.authenticate.verify</match_string>
777 <match_string>open-ils.auth.authenticate.complete</match_string>
778 + <match_string>open-ils.auth.login</match_string>
779 <match_string>open-ils.auth_proxy.login</match_string>
780 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
781 <match_string>open-ils.actor.user.password</match_string>
782 ---------------------------------------------------------------------
786 Administrators of Evergreen who use RTL locales and who have customized
787 `style-rtl.css.tt2` should now incorporate their customizations into
790 Multi-Time Zone Installations
791 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
793 For Evergreen consortia that span more than one time zone, the following
794 query will adjust all historical, unaged circulations so
795 that if their due date field is pushed to the end of the day, it is done
796 in the circulating library's time zone, and not the server time zone.
798 It is safe to run this after any change to library time zones.
800 Running this is not required, as no code before this change has
801 depended on the time string of '23:59:59'. It is also not necessary
802 if all of your libraries are in the same time zone, and that time zone
803 is the same as the database's configured time zone.
812 for ou_id in select id from actor.org_unit loop
813 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
814 if new_tz is not null then
815 update action.circulation
816 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
817 where circ_lib = ou_id
818 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
827 Deprecation of XUL staff client
828 -------------------------------
829 Starting with the release of 3.0.0, patches that fix XUL bugs will not
830 be merged into master or backported unless they meet one or more of
831 the following conditions:
833 a. the bug is a security issue
834 b. the bug involves the destruction of data
835 c. the bug is a regression of functionality in the XUL staff client
836 introduced by other work done to Evergreen
838 Under no circumstances will XUL staff client feature enhancements be merged.
840 This policy will continue through the 3.0.x and 3.1.x maintenance
841 release cycles, and will become moot upon the release of 3.2.0, when
842 the XUL staff client is slated to be entirely removed.
851 Evergreen 3.0 features a new, modern staff client that runs in the web browser
852 and can be used on desktop and mobile devices. All functional areas of the
853 system, including circulation, cataloging, acquisitions, serials, reports,
854 booking, administration, and offline circulation, are available in the new staff
855 client. Chrome and Firefox are officially supported for use with the web client.
857 Library staff will no longer need to download separate software to perform most
858 actions in Evergreen. A Chrome plugin called Hatch will be available as a
859 separate installation for workstations that require seamless, dialog-free
860 printing to multiple printers.
862 In addition to adding more portability and stability, the new staff client also
863 presents a cleaner and more modern interface for users. By virtue of running in
864 a browser, actions that users are accustomed to performing on other web sites
865 should now be available in the Evergreen client.
867 The old, XUL client will continue to be available to allow for a gradual
868 transition to the browser-based client, but no new features will be added. The
869 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
879 New EDI Order Generator
880 ^^^^^^^^^^^^^^^^^^^^^^^
885 . New database tables exist for configuring vendor-specific EDI order
889 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
892 ** Collection of `edi_attr`s. Each edi_account may be linked to one
894 ** One `edi_attr_set` per known vendor is added to the stock data, matching
895 the stock configuration found in the JEDI template.
896 * `acq.edi_attr_set_map`
897 ** Link between `edi_attr`s and `edi_attr_set`s.
899 . EDI Attribute Sets are manged via a new (browser client only) configuration
900 interface at 'Administration -> Acquisitions Administration -> EDI
903 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
904 is not set, default values will be used. Links between an EDI account
905 and an attribute set are managed in the EDI Accounts configuration
908 . Local modifications to the stock EG JEDI template are managed by modifying
909 and/or adding additional `edi_att_set`s as needed.
911 . A new `edi_order_pusher.pl` script is added which replaces the functionality
912 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
914 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
915 definition is no longer required and can be disabled.
920 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
921 specifies whether PO's generated via the account should be built using
922 EDI attributes or fall back to traditional JEDI A/T template generation.
924 This allows sites to activate EDI attributes on a per-account basis, making
925 it possible to migrate piecemeal to EDI attributes. For the initial roll
926 out of this new feature, no accounts will be configured to use EDI
927 attributes by default.
933 3 Day Courtesy Notice by SMS
934 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
935 New optional SMS text notification to be sent out 3 days prior to the due
936 date of any circulating item for patrons who have an SMS text number and
937 carrier stored in their accounts. This action trigger is disabled by default,
938 but can be enabled and modified by going into 'Administration -> Local Administration ->
939 Notifications / Action Triggers'.
941 You may wish to make use of granularity so that these messages are batched
942 and sent at the same time each day.
947 Add Description Field to Circulation and Hold Configuration Entries
948 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
949 The circulation and hold policy configuration rules now each have a
950 description field. This allows administrators to add comments to
951 describe the purpose of each rule.
956 Apache Internal Port Configuration Option
957 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
958 Apache configuration now supports a new variable which allows admins to
959 specify the port used by Apache to handle HTTP traffic. The value is
960 used for HTTP requests routed from Perl handlers back to the same Apache
961 instance, like added content requests. Use this when running Apache
962 with a non-standard port, typical with a proxy setup. Defaults to "80".
965 -------------------------------------------------------------------
968 PerlSetVar OILSWebInternalHTTPPort "7080"
971 -------------------------------------------------------------------
976 Configurable Bib Record Display Fields
977 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
979 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
980 fields: 'Display Field?' and 'Display XPath'.
982 When 'Display Field' is set to true, data from the field will be extracted
983 from each record and added to a new table of display data for each bib
986 If a value is present in the 'Display XPath' field, this XPath will be
987 applied to the extracted data *after* the base XPath (from the 'XPath'
988 field) is applied to each field.
990 This data acts as a replacement for the various and sundry ways bib record
991 data is currently extracted, including inline XPath in the TPAC, reporter
992 views, real-time 'MVR' compilation from MODS, etc. and will be available
993 to the user interface, notification templates, etc. for rendering bib
996 The browser client gets a new service 'egBibDisplay' which is capable
997 of translating the display field data from various formats into
998 data more suitable for JavaScript usage.
1000 The database gets 3 new views for representing display data in various
1003 * `metabib.flat_display_entry`
1004 ** List of all display fields linked to their configuration.
1005 * `metabib.compressed_display_entry`
1006 ** Same as `metabib.flat_display_entry` except there's one row
1007 per display field type, with 'multi' rows compressed into
1008 JSON arrays. Non-multi fields are represented as JSON
1010 * `metabib.wide_display_entry`
1011 ** Tabular view of display field data, one column per well-known
1012 field. Values are represented JSON, consistent with
1013 `metabib.flat_display_entry`. The view does *not* contain locally
1014 configured display fields, as each field must be encoded in
1015 the view and IDL definition. This is essentially a replacement
1016 for `reporter.simple_record`.
1021 After making changes to display field configuration, it's possible to
1022 reingest only display field data in the database using the following:
1025 ---------------------------------------------------------------------
1026 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1027 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1028 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1029 ---------------------------------------------------------------------
1035 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1036 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1037 The existing permission was incorrectly created with a code of
1038 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1039 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1040 update changes the permission code to match what the event requires.
1046 Hold Targeter V2 Repairs and Improvements
1047 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1048 * Make the batch targeter more resilient to a single-hold failure.
1049 * Additional batch targeter info logging.
1050 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1051 * Removes the confusingly named `--target-all` option
1052 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1053 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1055 New --next-check-interval Option
1056 ++++++++++++++++++++++++++++++++
1057 Specify how long after the current run time the targeter will retarget
1058 the currently affected holds. Applying a specific interval is useful
1059 when the retarget-interval is shorter than the time between targeter
1062 For example, if the targeter is run nightly at midnight with a
1063 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1064 since the holds won't be processed again until 48 hours later. This
1065 ensures that the org unit closed date checks are looking at the correct
1068 This setting overrides the default behavior of calculating the next
1069 retarget time from the retarget-interval.
1071 New --soft-retarget-interval Option
1072 +++++++++++++++++++++++++++++++++++
1073 This is a replacement for (and rebranding of) the `--skip-viable` option.
1074 The new option allows for time-based soft-targeting instead simple binary
1075 on/off soft-targeting.
1077 How soft-targeting works:
1079 * Update hold copy maps for all affected holds
1080 * Holds with viable targets (on the pull list) are otherwise left alone.
1081 * Holds without viable targets are retargeted in the usual manner.
1087 New marc_export --descendants Option
1088 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1090 The `marc_export` script has a new option, `--descendants`. This option
1091 takes one argument of an organizational unit shortname. It works much
1092 like the existing `--library` option except that it is aware of the
1093 org. tree and will export records with holdings at the specified
1094 organizational unit and all of its descendants. This is handy if you
1095 want to export the records for all of the branches of a system. You
1096 can do that by specifying this option and the system's shortname,
1097 instead of specifying multiple `--library` options for each branch.
1099 The `--descendants` option can be repeated, as the `--library` option can.
1100 All of the specified org. units and their descendants will be included
1101 in the output. It can also be combined with individual `--library`
1102 options when necessary.
1107 RTL and LTR Public Catalog Stylesheets Merged
1108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1109 The RTL stylesheet for the public catalog,
1110 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1111 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1112 template will provide RTL or LTR styles based on the value of
1113 the `rtl` flag of the active locale. An `rtl` variable is also available
1114 in the template to allow the correct style to be chosen.
1119 Miscellaneous Improvements
1120 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1122 * If a filter is in effect in the Library Settings Editor,
1123 the filter will continue to be applied after a user
1124 changes the selected library.
1125 * Copy templates used for serials now correctly link to age
1126 protection rules and MARC item type values (for the
1127 "Circ as Type" field). During upgrade, the database update
1128 will set to NULL any age protection and circ as type fields
1129 in serial copy templates that do not point to defined values.
1134 Obsolete Internal Flag Removed
1135 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1137 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1138 flag was removed from the `config.internal_flags` table. It was
1139 rendered obsolete by the addition of the 3 flags to control the
1140 browse, search, and facet indexing.
1145 Tweaks to Caching/Expiry of Public Catalog Assets
1146 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1147 The default cache expiration time for static assets (e.g.,
1148 CSS, image, and JavaScript files) in the public catalog and
1149 the Kid's PAC has been increased to one year. Links to all
1150 such assets now have a cache-busting value tacked on as a
1151 query parameter. This value is refreshed when `autogen.sh` is
1152 run, but it can also be manually set by adjusting the
1153 `ctx.cache_key` Template Toolkit variable.
1158 Action/Trigger Events Data Purging
1159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1161 Action/Trigger event definitions have a new field called 'Retention
1162 Interval'. When an optional interval value is applied, events and
1163 template output data linked to the event definition will be deleted
1164 from the database once they reach the specified age.
1166 Retention Interval Restrictions for Passive Hooks
1167 +++++++++++++++++++++++++++++++++++++++++++++++++
1169 Restrictions are placed on retention interval values for event definitions
1170 using passive hooks to prevent data from being deleted while it's still
1171 needed by the system.
1173 The presence of event data is how the system knows not to send duplicate
1174 events. As long as a scenario exists where a duplicate event may be
1175 generated, the events must be retained.
1177 To apply a retention interval value to a passive-hook event definition:
1179 * The event definition must have a max_delay value.
1180 * The retention interval must be larger than the difference between
1181 the `delay` and `max_delay` values.
1183 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1184 interval must be greater than 3 days to ensure no duplicate events are
1185 created between the first event on day 7 and the end of the event validity
1191 A new `purge_at_events.sh` script is installed in the bin directory
1192 (typically `/openils/bin`) which should be added to CRON for regular
1195 NOTE: On large data sets, this script can take a long time to run and
1196 create higher than normal I/O load as it churns though the event and
1197 event_output tables. You may wish to run the script by hand the first
1198 time so it can be monitored. It can be run in psql like so:
1201 ---------------------------------------------------------------
1202 SELECT action_trigger.purge_events();
1203 ---------------------------------------------------------------
1205 NOTE: On *very* large data sets (10s to 100s of millions of event and
1206 event_output rows), it may be advisable to first repopulate the `event`
1207 and `event_output` tables with only the desired data before starting
1208 regular purges. This can be done, for example, using the copy to temp
1209 table, truncate source table, repopulate source table from temp table
1210 approach. This will be much faster than the `purge_events()` function
1211 in cases where most of the data will be purged.
1216 A number of `action_trigger.hook` entries which have always been treated
1217 as active hooks, though are configured as passive hooks, have been
1218 updated to properly reflect the non-passive-ness. This allows for
1219 simpler configuration of their retention interval values.
1225 Remove JSPAC Redirects
1226 ^^^^^^^^^^^^^^^^^^^^^^
1227 Future versions of Evergreen will no longer contain automatic redirects
1228 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1229 that the JSPAC is no longer supported. Existing sites, however, may
1230 wish to retain JSPAC redirects in their Apache configuration files since
1231 JSPAC URLs may still be used in the wild to access their catalogs.
1233 The original JSPAC URL redirects are all retained in the file
1234 `Open-ILS/examples/jspac_redirects.conf` for reference.
1244 New open-ils.auth.login API
1245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1246 The `open-ils.auth` service has a new API for requesting an authentication
1247 token. It performs the same steps as the
1248 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1249 using the bare password. No intermediate password hashing is required.
1251 The paramaters are the same as the `.complete` call with a few modifications.
1253 1. Using the generic 'identifier' parameter in combination with the
1254 'org' parameter allows the API to reliably determine if an identifier
1255 value is a username or barcode. The caller is no longer required to
1256 make that determination up front.
1258 2. The 'nonce' parameter is no longer used.
1264 Batch Patron Contact Invalidation
1265 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1266 The following methods are used to mark patron contact fields
1267 as invalid by moving the invalid value to a standing penalty:
1269 * `open-ils.actor.invalidate.email`
1270 * `open-ils.actor.invalidate.day_phone`
1271 * `open-ils.actor.invalidate.evening_phone`
1272 * `open-ils.actor.invalidate.other_phone`
1274 These methods now accept a fifth argument specifying the value
1275 of the contact field, e.g., a specific phone number or email
1276 address. If supplied, and if a specific patron ID (the first
1277 argument) is not supplied, all patrons with that specific contact
1278 value will have it marked invalid.
1288 Pure-SQL catalog searching
1289 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1290 Public and staff catalog search is now both more accurate and faster
1291 by redesigning how the visibility of records is calculated.
1301 Authority Record and Headings Browse Improvements
1302 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1303 Various improvements are made to support for authority records
1304 and headings browsing:
1306 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1307 headings from authority records. Since the MODS and MADS stylesheets
1308 extract headings in similar ways, duplicate browse entries are now
1309 much less likely to occur.
1310 * A new configuration table, `authority.heading_field`, is now used
1311 to specify how headings should be extracted from authority records.
1312 * Related headings can now be identified as narrower or broader when
1313 browsing in the public catalog.
1314 * See references are now more reliably included in the browse list.
1315 * Scope (public) notes now display only under the main heading.
1316 * There is now a global flag, Display related headings (see-also) in browse,
1317 that can be used to control whether related headings (see-alsos) are
1318 displayed in the public catalog list.
1319 * A complete set of thesauruses are now included in the seed data. Thesauruses
1320 can now be identified using short and long codes.
1321 * The labels for see and see-also references in the public catalog are
1322 a bit more patron-friendly, and can now be tweaked via TPAC template
1323 customization in the browse.tt2 file.
1329 Copy Tags and Digital Bookplates
1330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1331 Copy tags will allow staff to apply custom, pre-defined labels or tags
1332 to copies. Copy tags are searchable in both the staff client and public
1333 catalog. This feature was designed to be used for Digital Bookplates to
1334 attach donation or memorial information to copies, but may be used for
1335 broader purposes to tag items.
1337 Each copy tag can either be publicly-visible or visible only to staff.
1338 Copy tags also have types that can be used for restricting catalog
1339 searches on copy tags to particular types.
1341 Copy tags are displayed in the copy table in the record summary page in
1342 the public catalog, and a new library setting can be used to add
1343 a "Digital Bookplate" search field. Copy tags can also be used
1344 as a search filter, e.g.,
1346 * `copy_tag(bookplate, jane smith)`: search for records that have a
1347 copy tag of type 'bookplate' whose value contains 'jane smith'.
1348 * `copy_tag(*, jane smith)`: search for records that have a
1349 copy tag of any type whose value contains 'jane smith'.
1351 All staff-side interfaces related to copy tags exist only in the web
1352 staff client. There are two new administration interfaces for managing
1353 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1354 button for applying copy tags to copies; that interface can also be
1355 used to create new copy tags on the fly. Furthermore, the copy buckets
1356 interface now has an 'Apply Tags' action for assigning tags to groups
1362 Two new permission are included:
1364 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1365 'Administration -> Server Administration -> Copy Tag Types'
1366 * `ADMIN_COPY_TAG`: required to create a new tag under
1367 'Administration -> Local Administration -> Copy Tags'
1369 The existing permission `UPDATE_COPY` controls whether or not a user
1370 can link copies to tags.
1374 A new library setting, 'Enable Digital Bookplate Search', controls
1375 whether to display a 'Digital Bookplate' field in the search index
1376 drop-downs in the catalog. A 'Digital Bookplate' search will include
1377 all records that have a copy that matches the tag specified by the user.
1378 It should be noted that this library setting does not affect the
1379 display of copy tags on the catalog record summary page.
1384 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1385 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1386 The call number prefix and suffix, when present, are now included in
1387 subfields $k and $m of the 852 field when running `marc_export` with
1388 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1389 server configured to embed item data in 852 fields, the affixes are now
1390 included in subfields $k and $m.
1400 Batch Editing of Patron Records
1401 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1402 There is a now a new interface analogous to the Copy Bucket interface
1403 to select and group a set of users into a User Bucket.
1404 The addition of users to a User Bucket is possible from the Patron Search
1405 interface by the use of a new grid Action, and directly on the User Bucket
1406 interface by user barcode. It is also possible to add users to a User
1407 Bucket by uploading a text file that contains a list of user barcodes.
1409 From this interface it is possible to perform a set of specific batch update
1410 operations on user records.
1415 These fields can now be changed in batch via an action on the User Bucket
1416 grid if the staff user has the `UPDATE_USER` permission:
1419 * Primary Permission Group (group application permissions consulted)
1421 * Home Library (`UPDATE_USER` checked against both old and new value)
1422 * Privilege Expiration Date
1423 * Barred flag (`BAR_PATRON` permission consulted)
1424 * Internet Access Level
1426 Changes made in this interface can be rolled back.
1428 As a batch process, rather than a direct edit, this mechanism explicitly skips
1429 processing of Action/Trigger event definitions for user update.
1434 The batch edit mechanism also allows for the batch deletion of user. The staff
1435 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1437 Changes made in this interface can be rolled back.
1439 As a batch process, rather than a direct edit, this mechanism explicitly skips
1440 processing of Action/Trigger event definitions for user deletion.
1442 This mechanism does not use the Purge User functionality, but instead simply
1443 marks the users as deleted.
1445 Editing Statistical Category Entries
1446 ++++++++++++++++++++++++++++++++++++
1448 All users in the bucket can have their Statistical Category Entries
1449 modified. Unlike user data field updates, modification of Statistical
1450 Category Entries is permanent and cannot be rolled back.
1452 As a batch process, rather than a direct edit, this mechanism explicitly skips
1453 processing of Action/Trigger event definitions for user update.
1455 New Service Requirement
1456 +++++++++++++++++++++++
1458 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1459 unused in production. If this service has been removed from the configuration
1460 of a live Evergreen instances, it will need to be added back in order for
1461 batch user editing to succeed.
1466 Honor Timezone of the Acting Library
1467 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1472 * Display day-granular due dates in the circulating library's timezone.
1473 * Only display the date portion of the due date for day-granular circulations.
1474 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1475 * Provide infrastructure for more advanced formatting of timestamps.
1476 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1481 This is a followup to the work done for 2.12, where we added the ability
1482 for the client to specify a timezone in which timestamps should be interpreted
1483 in business logic and the database.
1485 Most specifically, this work focuses on circulation due dates and the closed
1486 date editor. Due dates, where displayed using stock templates (including
1487 receipt templates) and used for fine calculation, are now manipulated in the
1488 library's configured timezone. This is controlled by the new 'lib.timezone'
1489 setting available via the Library Settings Editor, loaded from the server when
1490 required. Additionally, closings are recorded in the library's timezone so that
1491 due date calculation is more accurate. The closed date editor is also
1492 taught how to display closings in the
1493 closed library's timezone. Closed date entries also explicitly record if they
1494 are a full day closing, or a multi-day closing. This significantly simplifies
1495 the editor, and may be useful in other contexts.
1497 To accomplish this, we use the moment.js library and the moment-timezone addon.
1498 This is necessary because the stock AngularJS date filter does not understand
1499 locale-aware timezone values, which are required to support DST. A simple
1500 mapper translates the differences in format values from AngularJS date to
1503 Of special note are a set of new filters used for formatting timestamps under
1504 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1505 filters provide the functionality, and autogrid is enhanced to make use of
1506 these where applicable. egGrid and egGridField are also taught to accept
1507 default and field-specific options for applying date filters. These filters may
1508 be useful in other or related contexts.
1510 The egDueDate filter, used for all existing displays of due date via Angular
1511 code, intentionally interprets timestamps in two different ways WRT timezone,
1512 based on the circulation duration. If the duration is day-granular (that is,
1513 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1514 of seconds) then the date is interpreted as being in the circulation library's
1515 timezone. If it is an hourly loan (any duration that does not meet the
1516 day-granular criterium) then it is instead displayed in the client's timezone,
1517 just as all other timestamps currently are, because of the previous Evergreen
1520 The public catalog is adjusted to always display the due date in the circulating
1521 library's timezone. Because the public catalog displays only the date portion of the due
1522 date field, this difference is currently considered acceptable. If this proves
1523 to be a problem in the future, a minor adjustment can be made to match the
1524 egDueDate filter logic.
1526 Now that due dates are globally stored in the configured timezone of the
1527 circulating library, the automatic adjustment to day-granular due dates needs
1528 to take those timezones into account.
1530 An optional SQL command is provided by the upgrade script to retroactively
1531 adjust existing due dates after library configuration is complete.
1537 Enhancements to Hard Due Date Functionality
1538 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1539 It will now be possible to delete Hard Due Date Values for dates that have
1540 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1541 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1542 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1547 Patron Search by Birth Date
1548 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1549 * Now you can include the patron birth year and/or birth month and/or
1550 birth day when searching for patrons using the web staff client.
1551 * Day and month values are exact matches. E.g. month "1" (or "01")
1552 matches January, "12" matches December.
1553 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1554 1915, 1599, etc. For exact matches use the full 4-digit year.
1558 Patron Search from Place Hold
1559 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1560 This feature allows staff members, when placing a
1561 hold on behalf of a patron in the web staff client, to search for
1562 patrons by names and other searchable patron information, rather than
1563 relying on barcode alone. In particular, after performing a catalog
1564 search or going to a specific bib record and clicking the 'Place Hold'
1565 button, the form now includes a 'Patron Search' button. This button
1566 will open a dialog allowing the staff member search for and select
1572 Retrieve Recent Patrons
1573 ^^^^^^^^^^^^^^^^^^^^^^^
1575 Adds a new library setting 'Number of Retrievable Recent Patrons'
1576 ('ui.staff.max_recent_patrons') that specifies the number of recently
1577 retrieved patrons that can be re-fetched from the staff client.
1579 A value of 0 means no recent patrons can be retrieved.
1580 A value greater than 1 means staff will be able to retrieve multiple
1581 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1583 The default value is 1 for backwards compatibility.
1590 Fuller title in XUL client Simplified Pull List
1591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1592 The Simplified Pull List in the XUL client will now display subfields 245$n and
1593 $p in the title field. The addition will make it easier for staff to distinguish
1594 between different parts or seasons in a series.
1600 Transit Cancel Time and Terminology Change
1601 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1606 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1607 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1608 are preserved in the database, though still not visible to the end user in the staff client.
1609 This allows for better tracking of when transits are canceled for the purposes of knowing
1610 which staff member canceled the transit, etc.
1612 NOTE: This change may require the re-creation of transit reports to filter out canceled
1613 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1614 Is NULL' will suffice.
1616 "Canceled Transit" Terminology Change
1617 +++++++++++++++++++++++++++++++++++++
1619 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1620 For internal continuity, however, the following permission codes have not changed:
1623 * `ABORT_REMOTE_TRANSIT`
1624 * `ABORT_TRANSIT_ON_LOST`
1625 * `ABORT_TRANSIT_ON_MISSING`
1633 Offline Circulation Available in Web Staff Client
1634 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1635 Offline circulation is now available in the web staff client. In order to use the
1636 offline interface, users must first log into the web staff client, perform
1637 a patron search, select a user from the results, and open the patron editor
1638 interface to collect all the relevent configuration information for the
1639 workstation. In addition, the offline interface available from the Circulation
1640 menu provides a 'Download block list' button for users who are logged in.
1642 As is the case in the old staff client, users can check materials in and out,
1643 renew items, and create new patron accounts while offline. The patron fields
1644 available in the offline patron registration editor are the same ones that
1645 are available to staff when working online.
1649 Add Circ Modifier to Record Detail Page in Staff TPAC
1650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1651 The circulation modifier field is added to the table of copies to make
1652 more information available to staff without having to open
1659 Date+Time Format Settings for Web Client
1660 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1662 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1663 and adds two settings for use with the webstaff client:
1665 * 'Format Dates with this pattern'
1666 * 'Format Date+Time with this pattern'
1668 These settings use format strings as documented here:
1670 https://docs.angularjs.org/api/ng/filter/date
1672 There is overlap with how the Dojo formats worked, but also some differences.
1674 The original 'Format Dates' and 'Format Times' settings worked together, but the
1675 new settings work independently. Certain field elements will use one, and
1676 certain field elements will use the other. These distinctions are hard-coded
1677 in the various UI templates, with the idea being that timestamp fields in
1678 which the date component alone is sufficient information (for example, date of birth)
1679 will use the 'Format Dates' setting. Fields where the time component is
1680 important (for example, checkout time) will use the 'Format Date+Time' setting.
1682 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1683 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1689 Global Option to Remove Sound for a Specific Event
1690 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1691 A new `nosound.wav` file has been added to the web client. The file can be used
1692 to globally disable audio alerts for a specific event on an Evergreen system.
1694 For example, to silence the alert that sounds after a successful patron search:
1698 mkdir -p /openils/var/web/audio/notifications/success/patron/
1699 cd /openils/var/web/audio/notifications/success/patron/
1700 ln -s ../../nosound.wav by_search.wav
1707 The official Evergreen manual has been split into eight new manuals, each
1708 designed for a specific audience. This new approach is designed to make
1709 the documentation more readable and usable.
1711 The specific audiences for the new manuals are:
1713 * Acquisitions staff
1716 * Public services staff who use the public catalog
1718 * System administrators who use the command line
1719 * System administrators who use the Web client
1720 * System administrators and programmers who wish to integrate Evergreen
1721 with other technologies
1723 All manuals are available at http://docs.evergreen-ils.org
1729 Improvements to ebook API
1730 ^^^^^^^^^^^^^^^^^^^^^^^^^
1732 Evergreen now supports checking out and placing holds on
1733 OverDrive and OneClickdigital ebook titles from within the public
1734 catalog. This is an experimental feature. It is not recommended for production
1735 use without careful testing.
1737 When ebook integration is enabled, a "Check Out E-Item" link will be
1738 displayed when viewing an ebook title from a supported vendor in the
1739 catalog. Clicking on the link allows the user to check out and download
1740 that title from the vendor directly within the catalog.
1742 If no copies are available for the title, a "Place Hold on E-Item" link
1743 is displayed instead, and the user may place a hold on the title. (Note
1744 that some vendors require the user's account to have an email address
1745 before permitting a hold.)
1747 My Account includes the ability to view current ebook checkouts and
1748 holds, download already-checked-out titles, and cancel holds.
1750 For API integration to work, you need to request API access from the
1751 vendor, and the vendor must have a way of authenticating your patrons.
1752 Your Evergreen system also needs to be configured for ebook API
1753 integration, following the instructions in the command line system
1754 administration manual
1757 This feature assumes that you are importing MARC records supplied by the
1758 vendor into your Evergreen system, using Vandelay or some other MARC
1759 import method. This feature does not search the vendor's online
1760 collections or automatically import vendor records into your system; it
1761 merely augments records that are already in Evergreen.
1763 Improvements to Bill Payment Pages
1764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1765 The bill payment pages in the public catalog have been revamped
1768 * use the term "charges" instead of "fees"
1769 * include images of credit cards accepted
1770 * make the default print receipt template match other itemized receipts;
1771 note that this change is not automatically applied when upgrading.
1772 * display billing type
1773 * add button to pay only selected charges
1774 * reformat the credit card number input page
1780 Clickable Copy Locations
1781 ^^^^^^^^^^^^^^^^^^^^^^^^
1782 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1783 the associated copy location will display as a link in the public catalog summary display.
1784 This link can be useful for retrieving maps or other directions to the copy
1785 location to aid users in finding material.
1790 Download Checkout History CSV Fixed for Large Number of Circulations
1791 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1792 Downloading checkout history as a CSV from My Account has been fixed
1793 for users with a large circulation history. Previously, this would
1794 time out for patrons with more than 100 or so circulations.
1796 This feature no longer uses the action/trigger mechanism and the public catalog
1797 now generates the CSV directly. The old action/trigger code is still
1798 present in the database and should be removed at some point in the
1804 Google Books Preview Rewrite
1805 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1806 The Google Books Preview functionality in record detail pages has been
1807 rewritten to modernize its style and optimize its performance:
1809 * The Dojo JavaScript framework is no longer used, saving approximately
1810 150K of JavaScript and CSS and four network requests per page load.
1811 * The Embedded Viewer is not loaded unless a possible preview is found,
1812 saving more network and memory overhead.
1813 * The Google Books Loader is used to load the Embedded Viewer instead of the
1814 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1816 * All variables are self-contained and do not pollute the global namespace.
1817 * Event listeners are registered to handle clicks, rather than attaching
1818 `href="javascript:function()"` to <a> elements.
1819 * Book previews are displayed in a panel sized according to the viewport
1820 of the browser, improving its appearance on both mobile and desktop
1822 * The rewritten code is now served up directly from
1823 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1828 jQuery for the Public Catalog
1829 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1830 This release adds optional support for jQuery in the public catalog. This support
1831 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1832 `config.tt2` template.
1838 New Popularity Parameters
1839 ^^^^^^^^^^^^^^^^^^^^^^^^^
1840 New popularity parameters for in-house use over time and for count of distinct
1841 organizational units that own a title are now available. Evergreen sites
1842 can use these parameters to create new statistical popularity badges for
1843 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1845 The in-house use parameters will apply a badge to titles that have the most
1846 in-house use activity over time. The organizational unit count parameter
1847 will apply a badge to titles owned by the most number of libraries in a
1848 consortium. Ownership is determined by the copy's circulation library.
1853 Option to Suspend Holds at the Time They are Placed
1854 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1855 Users now have the option to suspend a hold at the same time they place the
1856 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1857 who want to suspend a hold at the time it is placed. There is also an option
1858 to set the activation date at the same time. This option is also available
1859 when placing holds on a batch of titles from 'My List' and will apply to
1860 all the titles in the batch.
1871 Fix to reporter.classic_current_circ View
1872 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1873 The `reporter.classic_current_circ` view, which is part of some
1874 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1875 has been fixed to not exclude loans for patrons who do not have a
1876 billing address set. Users of this view should rerun
1877 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1882 New Report Source Table Allowing Report of "Last" Deleted copy
1883 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1885 This source table allows you to construct a clever aggregate report template
1886 which will report bibliographic IDs where a library or a group of libraries
1887 no longer have a copy attached but *had* a copy attached. This is especially
1888 useful when a holdings sync is required with an external vendor.
1891 Instructions for creating a report template with this source:
1893 * Create a new report template using "Library Holdings Count with Deleted" as the source
1894 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1895 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1896 * 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"
1897 * Add "Bib ID" to Displayed Fields
1898 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1899 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1900 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1903 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1904 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1905 specified date range. Unfortunately the user will have to manually type the date range without the date
1906 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1907 copy and more than two deleted copies."
1912 Add Provider to Provider Note Link
1913 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1914 The Provider reporting source now includes a link to the Provider Note reporting source.
1919 Link ILS User and Working Location Reporting Sources
1920 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1921 The Working Location reporting source now has labels
1922 and it is now linked to the ILS User reporting source, allowing
1923 reports to display or filter on staff working location.
1928 New Circulation Report Source "All Circulation Combined Types"
1929 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1931 This report source will allow you to create a single report template for all of the following:
1934 * In-house uses of non-cataloged items
1936 * Circulations of non-cataloged items
1938 To distinguish between these different types of library use, it's important to display these columns
1939 in your report templates:
1948 Reports Template Searching
1949 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1950 A new form appears along the top of the reports interface for searching
1951 report templates. Once found, typical template actions (e.g. create new
1952 report) are available from within the results interface.
1954 Searches may be performed across selected (visible) folders or all
1955 folders visible to the logged in user.
1957 Searches are case-insensitive, any word order, with left-anchored words.
1958 All searched words must appear in at least one of the searched fields.
1963 * Searching for 'stat cat' matches:
1965 ** statistical category
1966 ** categories, statistical
1967 ** patrons (stat cat)
1968 * Searching for 'stat cat' does not match:
1970 *** both words must be present in the searched field(s)
1972 *** location contains 'cat' but it's not left-anchored.
1977 The templates, reports, and output interfaces now support paging via
1978 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1990 Web Staff Client Serials Module
1991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1992 The serials module has been ported over to the web staff
1993 client, implementing a unified serials interface that combines
1994 ideas from both the serial control view and alternate serials
1995 control view from the old staff client.
1997 In addition to carrying over functionality that was available
1998 in the old staff client, several new features are included:
2000 * the ability to save prediction pattern codes as templates
2001 that can be shared and reused within an Evergreen database
2002 * a more streamlined interface for managing subscriptions,
2003 distributions, and streams
2004 * it is no longer necessary to create a starting issue in
2005 order to predict a run of issues; the dialog box for
2006 generating a set of predicted issues now lets you specify
2007 the starting point directly.
2008 * the ability to more directly edit MFHDs
2010 The new serials interfaces can be accessed from the record
2011 details page via a Serials drop-down button that links to
2012 a subscription management page, a quick-receive action, and
2013 a MFHD management page. There is also a new 'Serials Administration'
2014 page where prediction pattern and serial copy templates can
2025 SIP Bugfix Changes How Encoding Is Determined in Configuration
2026 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2028 The combined fix for the above mentioned SIP bugs alters the way that
2029 SIPServer looks up the output encoding in the configuration file (typically
2030 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2033 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2034 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2035 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.
2036 4. If none of the above exist, then the default encoding (ASCII) is used.
2038 Number 3 is provided to ease the transition to the new code. It is
2039 the current location of the +encoding+ element in the sample
2040 configuration file and as such, where it is likely to be found in
2041 actual files. It is recommended that you alter your configuration to
2042 move this element out of the +implementation_config+ element and into
2043 its parent +institution+ element. Ideally, SIPServer should *not* look into
2044 the implementation config, and this check may be removed at some time
2052 Web Client Acknowledgments
2053 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2055 The project to develop a new browser-based web client launched four
2056 years ago at the September 2013 Evergreen developer hack-a-way when the
2057 developer community voted to move away from the XUL client and explore other
2058 platforms. The first web client preview became available in Evergreen 2.7 when
2059 circulation was available in the new platform.
2061 The browser-based client is available due to the work of many coders, testers,
2062 bug reporters, documentors, translators, project managers, spec writers, funders
2063 and other contributors over the past four years.
2065 The Evergreen project would like to acknowledge the following organizations
2066 that funded development of the Web Staff Client:
2069 * British Columbia Libraries Cooperative
2070 * Consortium of Ohio Libraries
2072 * Georgia Public Library Service
2073 * Grand Rapids Public Library
2075 * Kenton County Public Library
2076 * King County Library System
2079 * Pennsylvania Integrated Library System
2080 * Pioneer Library System
2083 The Evergreen project would also like to thank the following individuals who
2084 contributed code, translations, documentation patches, tests, bug reports,
2085 technical specifications, and project management to the Web Staff Client:
2122 * Freddy Enrique Pelayo Huapalla
2148 Evergreen 3.0 Acknowledgments
2149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2151 The Evergreen project would like to acknowledge the following
2152 organizations that commissioned developments in this release of
2156 * British Columbia Libraries Cooperative (BC Sitka)
2158 * Georgia Public Library Service
2159 * King County Library System
2161 * Pennsylvania Integrated Library System
2162 * Pioneer Library System
2164 We would also like to thank the following individuals who contributed
2165 code, translations, documentation patches, and tests to this release of
2214 We also thank the following organizations whose employees contributed
2217 * British Columba Libraries Cooperative
2221 * Emerald Data Networks, Inc.
2222 * Equinox Open Library Initiative
2224 * Grand Rapids Public Library
2225 * Indiana State Library
2227 * King County Library System
2228 * Lake Agassiz Regional Library
2229 * Laurentian University
2230 * Linn-Benton Community College
2232 * Merrimack Valley Library Consortium
2234 * North of Boston Library Exchange
2235 * Pennsylvania Integrated Library System
2236 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2238 * Traverse Area District Library
2240 We regret any omissions. If a contributor has been inadvertently
2241 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob