1 Evergreen 2.10.0 Release Notes
2 ==============================
9 * Support for PostgreSQL 9.1 is deprecated as of
10 the release of Evergreen 2.10.0. Users are recommended
11 to install Evergreen on PostgreSQL 9.2 or later.
12 * In the next major release following 2.10.0, Evergreen will no
13 longer officially support PostgreSQL 9.1.
14 * Please read the release notes thoroughly for information
15 about changes that Evergreen administrators may need
16 to make manually when upgrading to 2.10.0. In particular,
17 the enhancement to user password storage introduces a
18 new service, `open-ils.auth_internal`, and requires
19 changes to `opensrf.xml` in order for users to be able
32 PO Line item "paid" label
33 ^^^^^^^^^^^^^^^^^^^^^^^^^
34 A new "paid" label appears along the bottom of each line item in the PO
35 display when every non-canceled copy on the line item has been invoiced.
40 Disencumber funds on invoice close
41 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43 Fund debits linked to an invoice are now marked as paid (encumbrance=false)
44 when the invoice is marked as closed/complete instead of at invoice create
45 time. This is particularly useful for EDI invoices which may be
46 created well in advance of receipt and payment.
52 PO actions selector always visible
53 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55 The actions selector is now always visible in the purchase order view,
56 even when no line items exist. With this, users can print PO's that
57 only contain direct charges.
59 The custom "Add Brief Record" button is no longer present, since the
60 same action is accessible via the now-visible selector.
70 Set application name when connecting to database
71 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72 The services that connect directly to the PostgreSQL database
73 (and Clark Kent) now look for an application_name parameter
74 as part of the database login credentials specified in
75 `opensrf.xml`. If present, the value is used to set the
76 application name Pg connection value; this in turn shows up in
77 the Postgres `pg_stat_activity` table and Pg's logs.
82 Credit card receipts and privacy
83 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
85 To improve privacy and security, Evergreen now stores less data
86 about credit card transactions. The following fields are no
95 NOTE: All existing data within these fields will be deleted during
96 the upgrade. Reports using this data will no longer function.
98 Additionally, a tool has been added to Evergreen for clearing the
99 last 4 digits of the credit payment from the database after payments
102 Print/email templates
103 +++++++++++++++++++++
105 The stock print and email payment templates have been modified to no
106 longer use these fields, but only when the existing templates matched
107 the stock templates. If local changes have been applied, it will
108 be necessary to modify local templates to avoid referencing these
109 fields which no longer exist.
111 Any templates whose hook is "money.format.payment_receipt.print" or
112 "money.format.payment_receipt.email" may need modification. In stock
113 Evergreen, these are templates:
115 1. "money.payment_receipt.email" (stock id 29)
116 2. "money.payment_receipt.print" (stock id 30)
121 ---------------------------------------------
122 - [% CASE "credit_card_payment" %]credit card (
123 - [%- SET cc_chunks = mp.credit_card_payment.cc_number.replace(' ','').chunk(4); -%]
124 - [%- cc_chunks.slice(0, -1+cc_chunks.max).join.replace('\S','X') -%]
125 - [% cc_chunks.last -%]
126 - exp [% mp.credit_card_payment.expire_month %]/[% mp.credit_card_payment.expire_year -%]
128 + [% CASE "credit_card_payment" %]credit card
129 + [%- IF mp.credit_card_payment.cc_number %] ([% mp.credit_card_payment.cc_number %])[% END %]
130 ---------------------------------------------
132 Clearing the last 4 of the CC number
133 ++++++++++++++++++++++++++++++++++++
135 To activate automatic CC number clearing, add the following to opensrf's
136 crontab. Change timing to suit.
139 ---------------------------------------------
140 5 4 * * * . ~/.bashrc && $EG_BIN_DIR/clear_cc_number.srfsh
141 ---------------------------------------------
143 The default retention age is 1 year, but this can be changed by modifying
144 `clear_cc_number.srfsh` (typically found in `/openils/bin/`). Replace "1 year"
145 with the age of your choice.
152 Configure multiple telephony servers via action/trigger
153 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154 If you are using the AstCall action/trigger reactor
155 to generate callfiles to send to an Asterisk server, until
156 now the only place to specify the relevant configuration
157 was in `opensrf.xml`. However, this restricted an Evergreen
158 consortium to using only one Asterisk instance.
160 Now, the telephony parameters can also be specified as
161 A/T event parameters, allowing per-library configuration.
163 .Telephony parameters
165 | Name | Example value
174 | ["Zap/1", "Zap/2", "IAX/user:secret@widgets.biz"]
189 | ["MaxRetries: 3", "RetryTime: 60", "WaitTime: 30", "Archive: 1", "Extension: 10"]
195 Juvenile-to-adult batch script honors library setting
196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
198 The batch `juv_to_adult.srfsh` script that, when set up as a cronjob,
199 is responsible for toggling a patron from juvenile to adult now
200 honors the age value set in the library setting named "Juvenile Age
201 Threshold" (`global.juvenile_age_threshold`). When no library setting value
202 is present at a given patron's home library, the value passed in to the
203 script will be used as a default.
208 New reporting source for hold/copy ratios
209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
210 A new reporting source is added, "Hold/Copy Ratio per Bib
211 and Pickup Library (and Descendants)", that, for each bib
212 that has a hold request on it or any of its components,
213 calculates the following:
215 * active holds at each OU (including the OU's descendants)
216 * holdable copies at each OU (and its descendants)
217 * the ratio of the above two counts
218 * counts and ratio across the entire consortium
220 This source differs from the "Hold/Copy Ratio per Bib
221 and Pickup Library" source by including all descendants
222 of the organization unit one is filtering on.
224 One use case is allowing a multi-branch system within an
225 Evergreen consortium that doesn't do full resource sharing
226 to readily calculate whether additional copies should be
227 purchased for that system.
232 New patron action/trigger notice
233 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
235 A new action/trigger event definition ("New User Created Welcome Notice")
236 has been added that will allow you to send a notice after a new patron has
237 been created, based on the actor.usr create-date field.
239 This notice can be used for various tasks.
241 * Sending a welcome email to new patrons to market library services.
242 * Confirm that a new patron email address is correct.
243 * Generate postal notices to send a welcome packet to new patrons.
245 Enable this event in the staff client at *Admin* -> *Local Administration*
246 -> *Notifications / Action Triggers*.
251 Improved password management and authentication
252 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
253 Evergreen user passwords are now stored with additional layers of
254 encryption and may only be accessed directly by the database, not
255 the application layer.
257 All API changes are backwards compatible with existing 3rd-party
263 Passwords are migrated for each user automatically the first time a user
264 logs in under the new setup. However, it is also possible to force
265 password migration for a given user via a database function:
268 ------------------------------------------------------------
269 -- actor.migrate_passwd() will only migrate un-migrated
270 -- accounts, but it's faster to avoid any re-migration attempts.
271 SELECT actor.migrate_passwd(au.id)
273 LEFT JOIN actor.passwd pw ON (pw.usr = au.id)
274 WHERE pw.usr IS NULL;
275 ------------------------------------------------------------
277 Using this, admins could perform manual batch updates to force all
278 users to use the new, more secure passwords, regardless of when or
279 whether a patron logs back into the system.
281 Beware that doing this for all users in a large database will
282 take some time and should probably be performed in batches.
284 Changing Encryption Work Factor
285 +++++++++++++++++++++++++++++++
287 Roughly speaking, the 'work factor' determines the amount of time/effort
288 required to crack passwords. The higher the value, the more secure the
289 password. Higher values also mean that it takes longer for password
290 verification (e.g. during login) to work.
292 At time of release, Evergreen uses a work factor value of 10. The value
293 is set in the database table/column actor.passwd_type.iter_count (hash
294 iteration count). When this value is modified, any passwords created or
295 modified after the change will use the new work factor. Other passwords
296 will continue using the work factor in place when they were
297 created/modified, until they are changed once again.
299 Beware that raising the work factor can have a significant impact on
300 login speeds. A work factor of 10 requires ~0.1 seconds to verify a
301 password. A work factor of 15 takes almost 2 full seconds! Also beware
302 that once a password is encoded with a higher work factor, it cannot be
303 lowered again through any automatic means. The owner of the password
304 would have to log in and modify the password after the work factor is
307 Because of this, it's recommended that admins thoroughly test work
308 factor modifications before deploying to production.
310 To check encryption timing:
313 --------------------------------------------------------------------------
314 -- enable psql timing
317 -- encode password "HELLOWORLD" with a work factor of 10.
318 evergreen=# select crypt('HELLOWORLD', gen_salt('bf', 10));
322 --------------------------------------------------------------------------
324 open-ils.auth_internal
325 ++++++++++++++++++++++
326 To support the new storage mechanism, a new Evergreen service has
327 been added called `open-ils.auth_internal`. This service runs on
328 the private OpenSRF/XMPP domain and is used to store authenticated
329 user data in the authentication cache.
331 This is a required service and changes to `opensrf.xml` (typically
332 `/openils/conf/opensrf.xml`) are needed to run the new service.
334 .Modifying opensrf.xml
335 * A new `<open-ils.auth_internal>` app stanza is added to define the
337 * Cache timeout settings are moved from the app stanza for `open-ils.auth`
338 into `open-ils.auth_internal`
339 * `open-ils.auth_internal` is added to the set of running services for the
345 ---------------------------------------------------------------------
346 diff --git a/Open-ILS/examples/opensrf.xml.example b/Open-ILS/examples/opensrf.xml.example
347 index 3b47481..59f737a 100644
348 --- a/Open-ILS/examples/opensrf.xml.example
349 +++ b/Open-ILS/examples/opensrf.xml.example
350 @@ -424,6 +424,29 @@ vim:et:ts=4:sw=4:
353 <!-- defined app-specific settings here -->
355 + <seed>30</seed> <!-- amount of time a seed request is valid for -->
356 + <block_time>90</block_time> <!-- amount of time since last auth or seed request to save failure counts -->
357 + <block_count>10</block_count> <!-- number of failures before blocking access -->
362 + <!-- Internal authentication server -->
363 + <open-ils.auth_internal>
364 + <keepalive>5</keepalive>
365 + <stateless>1</stateless>
366 + <language>c</language>
367 + <implementation>oils_auth_internal.so</implementation>
369 + <max_requests>1000</max_requests>
370 + <min_children>1</min_children>
371 + <max_children>15</max_children>
372 + <min_spare_children>1</min_spare_children>
373 + <max_spare_children>5</max_spare_children>
376 + <!-- defined app-specific settings here -->
378 <!-- default login timeouts based on login type -->
380 @@ -431,13 +454,10 @@ vim:et:ts=4:sw=4:
382 <persist>2 weeks</persist>
385 - <seed>30</seed> <!-- amount of time a seed request is valid for -->
386 - <block_time>90</block_time> <!-- amount of time since last auth or seed request to save failure counts -->
387 - <block_count>10</block_count> <!-- number of failures before blocking access -->
391 + </open-ils.auth_internal>
395 <!-- Authentication proxy server -->
396 <open-ils.auth_proxy>
397 @@ -1177,6 +1197,7 @@ vim:et:ts=4:sw=4:
398 <appname>open-ils.circ</appname>
399 <appname>open-ils.actor</appname>
400 <appname>open-ils.auth</appname>
401 + <appname>open-ils.auth_internal</appname>
402 <appname>open-ils.auth_proxy</appname>
403 <appname>open-ils.storage</appname>
404 <appname>open-ils.justintime</appname>
405 ---------------------------------------------------------------------
414 Sortable HTML reports
415 ^^^^^^^^^^^^^^^^^^^^^
416 HTML reports can now be sorted by clicking on the header for a given column.
417 Clicking on the header toggles between sorting the column in ascending and
418 descending order. Note that sorting is available only when there are
419 at most 10,000 rows of output.
429 Additional fixed fields
430 ^^^^^^^^^^^^^^^^^^^^^^^
431 The AccM, Comp, CrTp, EntW, Cont, FMus, LTxt, Orig, Part, Proj, Relf, SpFm,
432 SrTp, Tech, and TrAr fixed fields have been defined and coded value maps added
433 so they can also be used for Advanced Searches or inclusion in Composite Value Maps.
435 Note that AccM, Cont, LTxt, Relf, and SpFm are compositite values based on
436 the values of "helper" fields like AccM(1), AccM(2), and so on. These positional
437 fields can be ignored.
439 Coded value maps have also been added for Cont, Ctry, and DtSt, and the Time field
440 has been defined. All of these fields are now available in the Fixed Field Editor
441 when editing the appropriate records.
446 Quickly export non-imported records
447 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
448 When inspecting a queue in MARC Batch Import/Export, there is now
449 a link to download to MARC file any records in the queue that were
450 not imported into the catalog. This allows catalogers to quickly
451 manipulate the records that failed to import using an external
452 tool, then attempt to import them again.
457 Link personal name/title series added entries
458 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
459 The authority linker script now supports linking the MARC21
460 field 800 (series added entry - personal name) to authority
466 MARC stream importer authority records and repairs
467 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
469 The MARC stream importer script, commonly used with external
470 services like OCLC Connexion, is now capable of importing authority
471 records in addition to bib records. A single running instance of
472 the script can import either type of record, based on the record
478 * --auth-merge-profile
480 * --bib-import-no-match
481 * --bib-auto-overlay-exact
482 * --bib-auto-overlay-1match
483 * --bib-auto-overlay-best-match
484 * --auth-import-no-match
485 * --auth-auto-overlay-exact
486 * --auth-auto-overlay-1match
487 * --auth-auto-overlay-best-match
492 The following options still work and map to the "bib" equivalent
493 of the option, however a deprecation warning message is generated
494 when the script is started.
497 * --auto-overlay-exact
498 * --auto-overlay-1match
499 * --auto-overlay-best-match
501 No longer supported options
502 +++++++++++++++++++++++++++
504 --import-by-queue is no longer supported. This option serves no
505 particular purpose and is a bad idea when re-using the same queue over
506 and over as most people do, because queue bloat will increase run times.
508 --noqueue (AKA "direct import") is no longer supported. All imports go
509 through Vandelay now.
514 Support for monograph parts import in MARC Batch Import/Export
515 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
516 When adding or overlaying copies in MARC Batch Import/Export
517 (Vandelay), monograph part labels can now be assigned during the import
518 process. This feature is modeled after the existing support for
519 statistical category import. As such, it:
521 * Uses '|' characters to separate labels to allow for multiple part
523 * Adds to (rather than replaces) any existing parts assigned to overlay
534 Alternate parts selection display when placing holds
535 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
536 Users often miss the list of parts on the Place Holds screen, leading to many
537 title-level holds on records where only one or two libraries may have
540 A new option is available to change this display so that a part is selected
541 via radio buttons instead of the traditional dropdown menu. This display
542 increases the visibility of parts on the Place Holds screen and also
543 forces users to make an explicit choice.
545 To enable the alternate display, set the enable.radio.parts option to 'true'
548 New config.tt2 setting
549 ++++++++++++++++++++++
553 Web staff client patron editor
554 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
555 The web staff interface now includes a patron editor/registration form
556 that is written using AngularJS, leading to faster and more responsive
557 patron editing. This feature is currently available in preview mode, but
558 supports the following actions:
560 * adding and editing base patron records and addresses
561 * setting statistical categories
562 * editing secondary groups
563 * cloning patron records
564 * duplicate detection
570 ==== Non-active status copy transit message ====
572 After copy checkin, if the copy is in transit, display a special
573 message in the transit alert dialog and in the printed transit receipt
574 (optionally, via macro) if the copy is in (or, rather, will be once it
575 arrives at its destination) a non-active copy status.
577 ===== Upgrade notes =====
579 * To add the new message to the transit slip, add the
580 'transit_copy_status_msg' MACRO.
581 * To remove the new message from the alert dialog, remove the
582 'staff.circ.utils.transit.copy_status_message' string property
583 from 'Open-ILS/xul/staff_client/server/locale/LOCALE/circ.properties'
584 * For a list of non-active copy statuses, see in the staff client
585 under Admin -> Server Administration -> Copy Statuses.
591 Selectively disallow opt-in based on patron's home library
592 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
593 A new library setting has been added which enables a library to prevent their
594 patrons from being opted in at other libraries.
596 For example, consider the following org unit hierarchy:
610 Suppose that SYS1 wishes to prevent its patrons from being opted in at SYS2.
611 To accomplish this, it sets the value of the "Restrict patron opt-in to home
612 library and related orgs at specified depth" setting to 1, meaning that patrons
613 at SYS1 libraries at or below that depth in the org tree cannot be opted in by
614 libraries outside that part of the org tree. Thus, BR1 patrons can be opted in
615 at BR2, but not at BR3 or BR4.
617 (This setting is distinct from the "Patron Opt-In Boundary" setting, which
618 merely determines the depth at which Evergreen prompts for the patron to opt
623 * Restrict patron opt-in to home library and related orgs at specified depth (`org.restrict_opt_to_depth`)
628 Standing penalty ignore proximity
629 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
631 Standing penalties now have an `ignore_proximity` field that takes an
632 integer value. When set, the value of this field represents the
633 proximity from the user's home organizational unit where this penalty
634 will be ignored for purposes of circulation and holds. Typical values
635 for this field would be 0, 1, or 2 when using a standard hierarchy of
636 Consortium -> System -> Branch -> Sublibrary/Bookmobile. A value of 1
637 would cause the penalty to be ignored at the user's home organization
638 unit, its parent and/or immediate child. A value of 2 should cause
639 it to be ignored at the above as well as all sibling organizational
640 units to the user's home. In all cases, a value of zero causes the
641 penalty to be ignored at the user's home and to apply at all other
642 organizational units. If the value of this field is left unset (or
643 set to a negative value), the penalty will still take effect
644 everywhere using the normal organizational unit and depth values. If
645 you use a custom hierarchy, you will need to figure out any values
646 greater than 0 on your own.
648 The `ignore_proximity` does not affect where penalties are applied. It
649 is used when determining whether or not a penalty blocks an activity
650 at the current organizational unit or the organizational unit that
651 owns the copy involved in the current transaction. For instance, if
652 you set the `ignore_proximity` to 0 on patron exceeds overdue fines,
653 then the patron will still be able to place holds on and checkout
654 copies owned by their home organizational unit at their home
655 organizational unit. They will not, however, be able to receive
656 copies from other organizational units, nor use other organizational
661 Patron checkout history stored in a dedicated table
662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
664 Patron checkout history is now stored in separate, dedicated database
665 table instead of being derived from the main circulation data. This
666 allows us to age/anonymize circulations more aggressively, since they
667 no longer need to stick around in cases where they represent a patron's
668 opt-in checkout history.
670 This has a number of patron privacy implications.
672 * Minimal metadata is stored in the new patron checkout history table,
673 so once the corresponding circulation is aged, the full set of
674 circulation metadata is no longer linked to a patron's reading history.
675 ** It is limited to checkout date, due date, checkin date, and copy data.
676 * Staff can no longer report on a patron's reading history.
677 ** While it is possible to build aggregate reports on reading history
678 data, it is not possible to report on which user an entry in the
679 history table belongs to. (The 'usr' column is hidden from the
681 * Staff can no longer retrieve a patron's reading history via API. Only
682 the user that owns the history data can access it.
687 Administrators should verify the CSV export of checkout history works after
688 deploying this change. If local changes were made to the CSV template,
689 the template will not be updated as part of this deployment. The stock
690 template was modified to handle gracefully NULL values for checkin_time.
695 ------------------------------------------------------------------------
696 - Returned: [% date.format(helpers.format_date(circ.checkin_time), '%Y-%m-%d') %]
699 + helpers.format_date(circ.checkin_time), '%Y-%m-%d')
700 + IF circ.checkin_time;
702 ------------------------------------------------------------------------
711 Holds count column picker option
712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
713 A new column picker option showing the number of holds for a given item will
714 now be available in various interfaces displaying item information, including
715 the patron's Items Out tab and the Item Status, Check Out, Check In, Renew
716 Item and Record In-House Use screens.
718 Note: Because the holds count is generated from the hold_copy_map, newly-added
719 items and items in a non-holdable status will not display accurate hold counts
720 until 24 hours after they have been added to the system or moved to a holdable
724 Distinct images for pop-ups and slips
725 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
726 The client now supports using distinct images for hold, transit, and booking
727 reservation popup windows and slips. In addition, three new images have been
728 provided, replacing the turtle that previously displayed. The turtle file
729 is still available in the images directory for those sites that still wish
738 Removal of unused methods
739 ^^^^^^^^^^^^^^^^^^^^^^^^^
740 The following public methods, which were both broken and not in use,
743 * `open-ils.actor.org_unit.closed_date.create`
744 * `open-ils.actor.org_unit.closed_date.delete`
753 Editable borrowing history
754 ^^^^^^^^^^^^^^^^^^^^^^^^^^
755 Patrons can now delete titles that they do not wish to appear in their
758 * In "My Account", click on the "Items Checked Out" tab, then
759 the "Check Out History" sub-tab.
760 * Check off the items to conceal.
761 * Click the Go button next to the "Delete Selected Titles" drop-down box.
762 * Click OK in the pop-up to confirm the deletion. Note that deletions
765 Deleted titles will also not appear in the downloaded CSV file.
767 Patron history disable warning
768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
770 When disabling checkout and/or holds history in the public catalog's
771 Search and History Preferences tab, patrons will be warned that the
772 operation is irreversible when history data exists that will be
773 deleted as part of the update.
777 Include parts label when sorting copies on the record details page
778 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
779 The list of copies on the catalog's record details page now includes
780 the part label in the default sort order.
782 Specifically, copies are now sorted by (in order), org unit, then
783 call number, then part label sortkey, then copy number, and
786 Previously, the hierarchy was org unit, then call number,
787 then copy number, and finally barcode
791 Quick option to change search scope to all libraries
792 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
793 A common usage of the catalog is to do a search in a restricted scope,
794 like a local library. When the results are lacking, the search is repeated in a
795 consortium-wide scope. This feature provides an optional button and checkbox
796 to alter the depth of the search to a defined level.
798 This feature is enabled by default and can be configured in the Depth Button/
799 Checkbox section of config.tt2.
801 New config.tt2 settings
802 +++++++++++++++++++++++
803 * ctx.depth_sel_checkbox
804 * ctx.depth_sel_button
805 * ctx.depth_sel_depth
806 * ctx.sel_button_label
807 * ctx.depth_sel_button_class
808 * ctx.depth_sel_checkbox_label
809 * ctx.depth_sel_tooltip
810 * ctx.depth_sel_resultshint
812 Limiter to exclude electronic resources
813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
814 A limiter to exclude electronic resources from search results is now available
815 on the advanced search screen and from the search results page. This limiter
816 will exclude any search results with an item form of o or s. This limiter
817 will be applied on top of any other format limiters used in the search.
819 The checkboxes are disabled by default. To display them in both places, set
820 the 'ctx.exclude_electronic_checkbox' setting in config.tt2 to 1.
822 New config.tt2 setting
823 ++++++++++++++++++++++
824 ctx.exclude_electronic_checkbox
829 Evergreen's unAPI support now includes access to many more
830 record types. For example, the following URL would fetch
831 bib 267 in MODS32 along with holdings, volume, copy,
832 and record attribute information:
834 https://example.org/opac/extras/unapi?id=tag::U2@bre/267{holdings_xml,acn,acp,mra}&format=mods32
836 To access the new unAPI features, the unAPI ID should have the
840 * followed by class name, which may be
842 * +biblio_record_entry_feed+ (multiple bibs)
843 * +acl+ (copy locations)
845 * +acnp+ (call number prefixes)
846 * +acns+ (call number suffixes)
848 * +acpn+ (copy notes)
850 * +ascecm+ (copy stat cat entries)
851 * +auri+ (located URIs)
852 * +bmp+ (monographic parts)
853 * +cbs+ (bib sources)
854 * +ccs+ (copy statuses)
855 * +circ+ (loan checkout and due dates)
856 * +holdings_xml+ (holdings)
857 * +mmr+ (metarecords)
858 * +mmr_holdings_xml+ (metarecords with holdings)
859 * +mmr_mra+ (metarecords with record attributes)
860 * +mra+ (record attributes)
861 * +sbsum+ (serial basic summaries)
862 * +sdist+ (serial distributions)
863 * +siss+ (serial issues)
864 * +sisum+ (serial index summaries)
865 * +sitem+ (serial items)
866 * +sssum+ (serial supplement summaries)
867 * +sstr+ (serial streams)
868 * +ssub+ (serial subscriptions)
869 * +sunit+ (serial units)
871 * followed by a record identifier (or in the case of
872 the +biblio_record_entry_feed+ class, multiple IDs separated
874 * followed, optionally, by limit and offset in square brackets
875 * followed, optionally, by a comma-separated list of "includes"
876 enclosed in curly brackets. The list of includes is
877 the same as the list of classes with the following addition:
878 * +bre.extern+ (information from the non-MARC parts of a bib
880 * followed, optionally, by +/+ and org unit; "-" signifies
881 the top of the org unit tree
882 * followed, optionally, by +/+ and org unit depth
883 * followed, optionally, by +/+ and a path. If the path
884 is +barcode+ and the class is +acp+, the record ID is taken
885 to be a copy barcode rather than a copy ID; for example, in
886 +tag::U2@acp/ACQ140{acn,bre,mra}/-/0/barcode+, +ACQ140+ is
887 meant to be a copy barcode.
888 * followed, optionally, by +&format=+ and the format in which the record
889 should be retrieved. If this part is omitted, the list of available
890 formats will be retrieved.
895 New form/genre search and facet index
896 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
897 The stock indexing definitions now include a search and facet index on the
898 form/genre field (tag 655). This allows genre links in the public catalog
899 record display to retrieve works in the same genre. The public catalog genre
900 links will no longer display content from the 659 MARC fields.
902 The genre facet will also display by default in the public catalog. A partial
903 reingest during upgrade is required to use this index.
908 Limit number of facets retrieved during search
909 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
910 Catalog search now limits the number of facets retrieved
911 per defined facet field. Setting a limit is useful so that
912 `open-ils.cstore backends don't end up needlessly consuming
913 memory when fetching facets for a large result set; if a broad
914 search retrieves over 10,000 author facets (say), even the most
915 persistant user is not going to actually look at all of them. Fetching
916 fewer facets can also slightly speed up generation of search results.
918 The limit is controlled by a new global flag, `search.max_facets_per_field`,
919 whose label is "Search: maximum number of facet values to retrieve for
920 each facet field". The default limit value is 1,000, but lower values
921 (e.g., 100) are perhaps even better for most catalogs.
926 Add acquisitions cancel reason 85 for Baker & Taylor EDI
927 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
928 Baker & Taylor send backs a quantity status code of 85
929 when a line item is canceled when using EDI. That code
930 is now included in the system so those cancelations get
935 Corrections were made to the self-check holds and fines printing
936 functionality to so that the proper transactions can be printed.
937 The change requires that the Self-Checkout Fines Receipt and
938 Self-Checkout Holds Receipt action/trigger templates be updated
939 in order to work properly.
944 * Copy records in the "Concerto" test data set now have prices.
945 * The web-based self-check interface now displays the patron
946 information area only when a patron is logged in.
947 * The progress page displayed by MARC Batch Edit is improved.
948 * The public catalog now better handles the situation where
949 a patron who does not have an email address registered in
950 Evergreen tries to email a record.
952 Bugs and enhancement requests closed in this release
953 ----------------------------------------------------
955 * https://bugs.launchpad.net/bugs/838525[Bug 838525: Timestamp on dob can make date appear off by a day]
956 * https://bugs.launchpad.net/bugs/963341[Bug 963341: Allow the JSPac and TPac to display both MFHD records and Serial Control/Alternate records,]
957 * https://bugs.launchpad.net/bugs/1067823[Bug 1067823: tpac: genre links in record details page launch subject search]
958 * https://bugs.launchpad.net/bugs/1164174[Bug 1164174: Add support for author/title series added entry]
959 * https://bugs.launchpad.net/bugs/1175711[Bug 1175711: can't renew items on OPAC due to items being on Booking resource list]
960 * https://bugs.launchpad.net/bugs/1197636[Bug 1197636: Email record detail does not check for email]
961 * https://bugs.launchpad.net/bugs/1202742[Bug 1202742: Support alert/print message for transiting, non-active copies]
962 * https://bugs.launchpad.net/bugs/1206936[Bug 1206936: money.transaction_billing_summary view displays incorrect billing_type and billing_note for the actual last transaction]
963 * https://bugs.launchpad.net/bugs/1208613[Bug 1208613: Expand All button does not work past the 1st page when viewing a large picklist.]
964 * https://bugs.launchpad.net/bugs/1229757[Bug 1229757: support distinct pop-up images for holds, transits, and hold transits]
965 * https://bugs.launchpad.net/bugs/1240657[Bug 1240657: OpenILS::Application::Actor should check_perms for CREATE_CLOSED_DATE, not CREATE_CLOSEING]
966 * https://bugs.launchpad.net/bugs/1251415[Bug 1251415: Use the juvenile setting when auto-removing juvenile flag.]
967 * https://bugs.launchpad.net/bugs/1275118[Bug 1275118: Holds history displays canceled holds as active]
968 * https://bugs.launchpad.net/bugs/1312699[Bug 1312699: Editable Checkout History]
969 * https://bugs.launchpad.net/bugs/1319998[Bug 1319998: money.materialized_summary_billing_del() ADDS to balance_owed]
970 * https://bugs.launchpad.net/bugs/1333254[Bug 1333254: EDI invoices automatically expend debits]
971 * https://bugs.launchpad.net/bugs/1367926[Bug 1367926: Add support for (nearly) direct access to the full unapi backend]
972 * https://bugs.launchpad.net/bugs/1370694[Bug 1370694: Selfcheck "Print List" for Holds view does not work]
973 * https://bugs.launchpad.net/bugs/1371647[Bug 1371647: config.marc21_ff_pos_map needs an audit]
974 * https://bugs.launchpad.net/bugs/1375043[Bug 1375043: Support for in-A/T telephony configuration]
975 * https://bugs.launchpad.net/bugs/1380709[Bug 1380709: invoice print amounts-per-fund uses wrong value when item price varies]
976 * https://bugs.launchpad.net/bugs/1384740[Bug 1384740: Add authority records support to marc stream importer (Connexion)]
977 * https://bugs.launchpad.net/bugs/1391282[Bug 1391282: Default Action Trigger Templates Updates]
978 * https://bugs.launchpad.net/bugs/1392396[Bug 1392396: Wishlist: Action Trigger for new user creation]
979 * https://bugs.launchpad.net/bugs/1402018[Bug 1402018: Acq Copy location UI scoped to registered workstation]
980 * https://bugs.launchpad.net/bugs/1402770[Bug 1402770: Add column picker option for number of holds in item context]
981 * https://bugs.launchpad.net/bugs/1406786[Bug 1406786: Merge parts functionality fails to preserve copy_part mapping]
982 * https://bugs.launchpad.net/bugs/1422802[Bug 1422802: Parts need to be more visible on the place holds screen]
983 * https://bugs.launchpad.net/bugs/1422932[Bug 1422932: TPAC: Holds history pager typo]
984 * https://bugs.launchpad.net/bugs/1429268[Bug 1429268: Credit card payment fails on NULL mailing address]
985 * https://bugs.launchpad.net/bugs/1452950[Bug 1452950: Angularize the patron editor]
986 * https://bugs.launchpad.net/bugs/1454871[Bug 1454871: KPAC Hold Notifications - SMS]
987 * https://bugs.launchpad.net/bugs/1454884[Bug 1454884: Hold placed on grouped metabib result displays wrong title]
988 * https://bugs.launchpad.net/bugs/1464765[Bug 1464765: evergreen.lpad_number_substrings doesn't handle internal substring matches properly]
989 * https://bugs.launchpad.net/bugs/1466173[Bug 1466173: Wishlist: Selfcheck Hide UI Elements until patron auth]
990 * https://bugs.launchpad.net/bugs/1466990[Bug 1466990: Detailed search results shows parts for items that dont have parts]
991 * https://bugs.launchpad.net/bugs/1468422[Bug 1468422: Improve Password Management and Authentication]
992 * https://bugs.launchpad.net/bugs/1470957[Bug 1470957: Items are incorrectly sorting when using the Sort By Publication date feature]
993 * https://bugs.launchpad.net/bugs/1474051[Bug 1474051: Avoid storing partial credit card payment info]
994 * https://bugs.launchpad.net/bugs/1474455[Bug 1474455: Fixed navigation menu for the web client]
995 * https://bugs.launchpad.net/bugs/1474566[Bug 1474566: Credit card API amount paid rounding error.]
996 * https://bugs.launchpad.net/bugs/1482336[Bug 1482336: create_release_notes.sh include .adoc files]
997 * https://bugs.launchpad.net/bugs/1483500[Bug 1483500: evergreen.lowercase needs test]
998 * https://bugs.launchpad.net/bugs/1483506[Bug 1483506: public.first_agg needs test]
999 * https://bugs.launchpad.net/bugs/1483508[Bug 1483508: public.text_concat needs tests]
1000 * https://bugs.launchpad.net/bugs/1486151[Bug 1486151: Modifying password regular expression in Library Settings Editor can cause helper on the Update Password page to be invalid]
1001 * https://bugs.launchpad.net/bugs/1486294[Bug 1486294: Add acquisitions data to the Concerto dataset]
1002 * https://bugs.launchpad.net/bugs/1486592[Bug 1486592: Copies in concerto data should have prices]
1003 * https://bugs.launchpad.net/bugs/1487527[Bug 1487527: TPAC: Provide shortcut for changing search scope]
1004 * https://bugs.launchpad.net/bugs/1491571[Bug 1491571: When circ.password_reset_request_requires_matching_email setting is true, email case must match in addition to content]
1005 * https://bugs.launchpad.net/bugs/1492793[Bug 1492793: Support for PostgreSQL Application Name Connection Options]
1006 * https://bugs.launchpad.net/bugs/1496837[Bug 1496837: xml-related test is invalid]
1007 * https://bugs.launchpad.net/bugs/1499123[Bug 1499123: Ability to Ignore Certain Standing Penalties Within a Proximity to the Patron's Home Library]
1008 * https://bugs.launchpad.net/bugs/1501471[Bug 1501471: fetching OU settings in batch can be made faster]
1009 * https://bugs.launchpad.net/bugs/1501516[Bug 1501516: Indicate whether a lineitem is fully paid/invoiced in PO list]
1010 * https://bugs.launchpad.net/bugs/1502152[Bug 1502152: Trap Warnings in marc_export for better error reporting]
1011 * https://bugs.launchpad.net/bugs/1504615[Bug 1504615: OPAC: Suggest record detail more useful when sorted by parts]
1012 * https://bugs.launchpad.net/bugs/1505286[Bug 1505286: set limit on facets retrieved during search]
1013 * https://bugs.launchpad.net/bugs/1506534[Bug 1506534: valid_z3950_attr_type check constraint can cause errors during pg_restore]
1014 * https://bugs.launchpad.net/bugs/1507845[Bug 1507845: Correct search engine optimization -- allow robots to crawl, but not index, results]
1015 * https://bugs.launchpad.net/bugs/1508477[Bug 1508477: browser client: hotkeys don't work if an input element has focus]
1016 * https://bugs.launchpad.net/bugs/1509479[Bug 1509479: infinite loop when parsing modified unclosed phrase search query]
1017 * https://bugs.launchpad.net/bugs/1510641[Bug 1510641: Cannot print PO without lineitems]
1018 * https://bugs.launchpad.net/bugs/1513554[Bug 1513554: It is possible to delete acq.cancel_reasons that are used by the system]
1019 * https://bugs.launchpad.net/bugs/1516022[Bug 1516022: reporting source for copy/hold ratio at pickup library and descendants]
1020 * https://bugs.launchpad.net/bugs/1516104[Bug 1516104: Wishlist: Additional Acq Toolbar Options]
1021 * https://bugs.launchpad.net/bugs/1516707[Bug 1516707: Relevance ranking deteriorates when phrases are added to search]
1022 * https://bugs.launchpad.net/bugs/1516757[Bug 1516757: SIP Date of Birth off by one day / parsed as UTC]
1023 * https://bugs.launchpad.net/bugs/1516867[Bug 1516867: HTML reports should be dynamically sortable]
1024 * https://bugs.launchpad.net/bugs/1519055[Bug 1519055: Simple checkbox to exclude electronic resources from search results]
1025 * https://bugs.launchpad.net/bugs/1519465[Bug 1519465: Purchase Orders with spaces in the name cause problems with EDI processing]
1026 * https://bugs.launchpad.net/bugs/1519911[Bug 1519911: Typo in seed data for hold cancel notification action triggers]
1027 * https://bugs.launchpad.net/bugs/1519925[Bug 1519925: Add UPC search to MARC Federated Search - Native Evergreen option]
1028 * https://bugs.launchpad.net/bugs/1522538[Bug 1522538: Unexpected Journal Title Search Results when using second or third Search Input in Advanced Search]
1029 * https://bugs.launchpad.net/bugs/1522604[Bug 1522604: webclient: Red font to highlight Lost items in patron summary extends to Non-Cataloged label]
1030 * https://bugs.launchpad.net/bugs/1526543[Bug 1526543: Cannot disable password reset in TPAC]
1031 * https://bugs.launchpad.net/bugs/1526546[Bug 1526546: Parts do not sort correctly on Holdings Maintenance screen]
1032 * https://bugs.launchpad.net/bugs/1526547[Bug 1526547: Overdues adjusted via lost (or long overdue) processing get an incorrect note ("VOIDED FOR BACKDATE")]
1033 * https://bugs.launchpad.net/bugs/1527342[Bug 1527342: Maintain patron reading history in a dedicated table.]
1034 * https://bugs.launchpad.net/bugs/1528596[Bug 1528596: Another untrapped marc_export warning]
1035 * https://bugs.launchpad.net/bugs/1531976[Bug 1531976: Triggered Events UI not loading after visiting Message Center UI and vice-versa]
1036 * https://bugs.launchpad.net/bugs/1533329[Bug 1533329: Selectively disallow opt-in based on patron's home library]
1037 * https://bugs.launchpad.net/bugs/1533331[Bug 1533331: evergreen.protect_reserved_rows_from_delete() trigger function returning error]
1038 * https://bugs.launchpad.net/bugs/1538697[Bug 1538697: webclient: copy record does not save when changing stat cat entries]
1039 * https://bugs.launchpad.net/bugs/1539088[Bug 1539088: marc export should only print "Waiting for Input" when running interactively]
1040 * https://bugs.launchpad.net/bugs/1539776[Bug 1539776: webclient: Wrapping improvements for vol / copy editor]
1041 * https://bugs.launchpad.net/bugs/1544723[Bug 1544723: Add webstaff to update_pofiles]
1042 * https://bugs.launchpad.net/bugs/1545178[Bug 1545178: two dead methods for dealing with closed dates should be removed]
1043 * https://bugs.launchpad.net/bugs/1545226[Bug 1545226: MARC Batch Editor summary table html problems]
1044 * https://bugs.launchpad.net/bugs/1546125[Bug 1546125: Print Templates -> Save Locally not working]
1045 * https://bugs.launchpad.net/bugs/1548143[Bug 1548143: Add Parts Support to Vandelay Item Import]
1046 * https://bugs.launchpad.net/bugs/1548147[Bug 1548147: Quick Export Feature for Vandelay Queues]
1047 * https://bugs.launchpad.net/bugs/1548869[Bug 1548869: KPAC - hold results screen not showing title]
1048 * https://bugs.launchpad.net/bugs/1549393[Bug 1549393: AddedContent: Invalid ISBN's are sent to Content Cafe as blank string]
1049 * https://bugs.launchpad.net/bugs/1550495[Bug 1550495: EDI Default Cancel Reason for Baker & Taylor not included: Code 85]
1050 * https://bugs.launchpad.net/bugs/1551447[Bug 1551447: Selfcheck: Printing Fines Prints All Open Transactions]
1051 * https://bugs.launchpad.net/bugs/1552060[Bug 1552060: Persistent login no longer working in OPAC]
1052 * https://bugs.launchpad.net/bugs/1553813[Bug 1553813: Browser patron editor field validation and permission checks]
1053 * https://bugs.launchpad.net/bugs/1556339[Bug 1556339: API attempts to use nonexistent user_visible_circs method]
1054 * https://bugs.launchpad.net/bugs/1557525[Bug 1557525: Release Notes Omission]
1055 * https://bugs.launchpad.net/bugs/1557621[Bug 1557621: Verify password API fails on barcode; returns success on deleted users]
1056 * https://bugs.launchpad.net/bugs/1557683[Bug 1557683: Missing semicolon in 0953.function.unapi-bre.external-includes.sql]
1060 The Evergreen project would like to thank the following
1061 individuals who contributed code, documentations patches and
1062 tests to this release of Evergreen:
1096 We would also like to thank the following individuals who
1097 tested and signed off on patches:
1103 We would also like to thank the following organizations who
1104 commissioned developments in this release of Evergreen:
1106 * Linn Libraries Consortium
1107 * King County Library System
1110 We also thank the following organizations whose employees contributed
1113 * BC Libraries Coooperative
1114 * Berklee College of Music
1120 * Georgia Public Library Service
1121 * Indiana State Library
1122 * Kent County Public Library
1123 * King County Library System
1124 * Lake Agassiz Regional Library
1125 * Laurentian University
1130 * Rodgers Memorial Library
1133 We regret any omissions. If a contributor has been inadvertantly
1134 missed, please open a bug at http://bugs.launchpad.net/evergreen/