Docs: 3.6 release notes update
[Evergreen.git] / docs / RELEASE_NOTES_3_6.adoc
1 = Evergreen 3.6-beta1 Release Notes =
2 :toc:
3 :numbered:
4
5 == Upgrade notes ==
6
7 This release adds a new OpenSRF service called `open-ils.courses`.
8 While strictly speaking this is an optional service and could be
9 omitted if you are not planning on using the new Course Materials
10 module, it is recommended that the service be run in case future
11 work bakes in an assumption that it will always be present.
12
13 This release also a new OpenSRF service, `open-ils.curbside`, which
14 must be enabled and registered with the public router for the 
15 Curbside Pickup feature to function.
16
17 This release also includes a new experimental public catalog skin
18 based on the Bootstrap framework. Instructions for turning it on
19 can be found below.
20
21 This release adds a new Perl module dependency, `Config::General`.
22
23 This release adds two new rows to action_trigger.event_definition, 
24 two into action_trigger.hook, and six into action_trigger.environment.
25
26 == New Features ==
27
28 === Acquisitions ===
29
30 ==== Angular Acquisitions Search ====
31
32 The acquisitions search interfaces are now written in Angular
33 and provide a new centralized place for searching Line Items,
34 Purchase Orders, Invoices, and Selection Lists in the Acquisitions
35 module of Evergreen. The Acquisitions Search interface can be accessed
36 under Acquisitions -> General Search.
37
38 The search interface has four tabs for line item search, purchase order
39 search, invoices search, and selection list search.  Each tab
40 offers a search form allowing the user to select one or more
41 fields to search on. Each search tab stores a separate default search
42 that the user can update; for example, a user could have their
43 line item search default to showing all on-order line items from
44 a particular provider.
45
46 The grid that displays search results in each tab is filterable.
47
48 The line items and PO search interfaces allow the user to navigate to
49 linked POs, invoices, and so forth, but offers no direct actions. The
50 invoices search tab includes a 'Print Selected Invoices' action,
51 while the selection lists search tab offers actions to create,
52 clone, delete, and merge selection lists.
53
54 The Angular search page contains a link to the legacy Dojo search
55 interface if needed. The Dojo interface will be removed in a future
56 release of Evergreen.
57
58 The Angular search interface offers various usability improvements
59 over the Dojo one, including:
60
61 * only the search operators that are relevant for a given field
62   are displayed.
63 * search fields that are associated with controlled vocabularies
64   will display drop-downs on the search form.
65 * results are sortable.
66 * the line item and PO state fields have been relabeled to "Status".
67 * greater than and less than are now available as search operators.
68 * publication date searches are more flexible.
69
70 ===== Adjustments to Stock Permissions =====
71
72 As part of this feature, the stock permissions for the Acquisitions
73 and Acquisitions Administrator profiles have been expanded. In
74 particular, the Acquisitions Administrator profile can now be
75 more readily used to perform normal acquisitions work in addition
76 to configuring the acquisitions module.
77
78 ==== Angular Providers Interface ====
79
80 The interfaces for searching for and managing Acquisitions provider
81 records have been rewritten in Angular. This rewrite includes the
82 following significant changes:
83
84 * The provider search interface is now available directly from the
85   Acquisitions menu, supplementing its longstanding availability from
86   the Acquisitions Administration page.
87 * The search interface is modeled after the patron interface, including
88   a search form that can be hidden or displayed, a provider summary box,
89   and a multi-tabbed interface for managing the provider itself.
90 * The grid displaying search results is filterable and sortable.
91 * The provider display tabs are
92 ** Details, allowing the user to view, and if permitted, edit the base provider record.
93 ** Addresses
94 ** Contacts
95 ** Attribute Definitions
96 ** Holdings Definitions
97 ** EDI
98 ** Invoices, providing an interface for viewing the invoices associated with the provider.
99 ** POs, providing an interface for viewing the purchase orders associated with the provider.
100 * The new interface makes it possible to edit contact addresses.
101 * The base provider record now has an optional primary contact field.
102   Selecting a contact as the primary one is managed on the Contacts
103   tab.  The primary contact, if set, is displayed on the provider
104   summary box.
105
106 Interfaces that used to link to the Dojo provider interface now link
107 to the Angular one instead.
108
109 === Administration ===
110
111
112 ==== Changes to Autorenewal Action/Trigger Failure Reasons ====
113
114 Previously the "reason" field in the userdata for an Autorenewal
115 event would contain both the failure code and the description for
116 the failure event as a single string such as
117 "MAX_RENEWALS_REACHED : Circulation has no more renewals remaining."
118
119 Now the "reason" field will only contain the description of the issue
120 (Circulation has ...) while a new "textcode" field will contain the
121 event code (MAX_RENEWALS_REACHED) if administrators still want to
122 display it in template outputs.
123
124
125 ==== EZProxy authentication ====
126
127 Evergreen can now provide CGI authentication for EZProxy.
128 To enable this, you will need to:
129
130 . Add a new User Activity Type to Evergreen for EZProxy CGI authentications.
131 . Add a new Remote Authentication Profile to Evergreen. You will probably want
132 to use `EZProxyCGI` as the name.
133 . Edit the `<Location /api/ezproxy>` stanza in Evergreen's eg_vhost configuration
134 file. In particular, you will need to allow access to from your EZProxy server,
135 fill in the base uri of your EZProxy server, and add a secret to the
136 _OILSRemoteAuthEZProxySecret_ variable.
137 . Restart Apache.
138 . Edit the EZProxy user.txt file.  You will likely want to add a stanza such
139 as the following:
140
141 .Sample user.txt stanza
142 ----
143 ::CGI=http://your-evergreen-catalog.com/api/ezproxy?url=^R
144 ::Ticket
145 MD5 <same secret as in eg_vhost config>
146 Expired; Deny expiredticket.htm
147 /Ticket
148 ----
149
150 When this feature is enabled, users will see an Evergreen-based login screen.
151 You may customize the look and feel of this login screen by editing the relevant
152 template toolkit files.
153
154 ==== Matomo Support ====
155
156 Support for the open source web analytics platform Matomo is now
157 native to Evergreen. Support is on an org unit level so different
158 libraries can have separate or no analytics. Once you setup
159 a Matomo service you will need the URL and site ID. Typically
160 Matomo will give you a block of javascript you can insert into
161 web sites. One line will look like :
162
163 `var u="http://mylibrary.lib/matomo/";`
164
165 The full URL in the double quotes will be your URL.  Another line
166 will look like:
167
168 `_paq.push(['setSiteId', '1']);`
169
170 In this case the number 1 will be your site ID.
171
172 These are set by the Library Settings opac.analytics.matomo_url and
173 opac.analytics.matomo_id respectively.  A new permission,
174 MATOMO_UPDATE_SETTINGS, controls access to these.
175
176 ==== "PatronAPI" authentication ====
177
178 Evergreen now supports the III "PatronAPI" scheme for authenticating
179 patrons and supplying some information about them.
180
181 To enable this, you will need to:
182
183 . Add a new User Activity Type to Evergreen for PatronAPI authentications.
184 . Add a new Remote Authentication Profile to Evergreen. You will probably want
185 to use `PatronAPI` as the name.
186 . Edit the `<Location /api/patronapi>` stanza in Evergreen's eg_vhost configuration
187 file. In particular, you will need to allow access to it from the server(s)
188 wanting to make PatronAPI requests, determine whether to enable the PatronAPI
189 "dump" feature, and specify whether users can be identified by username
190 or barcode.
191 . Restart Apache.
192 . Update the PatronAPI client to use https://your.evergreen.server/api/patronapi
193   as its base URL.
194
195 Example PatronAPI URLs look something like this:
196
197 .PatronAPI URLs
198 ----
199 # test a patron's PIN:
200 https://evergreen.example.org/api/patronapi/USERNAME/PASSWORD/pintest
201
202 # dump some information about the patron. Note that this
203 # does _not_ require the the patron's password be supplied.
204 https://evergreen.example.org/api/patronapi/USERNAME/dump
205 ----
206
207 The responses for the `pintest` and `dump` actions are specified by
208 Template Toolkit templates under (e.g.) `/openils/var/templates/remoteauth`.
209
210
211 ==== Preloaded Audio Icon and Search Format ====
212
213 A new search and icon format called Preloaded Audio now exists 
214 that overlaps with the eAudio format.  If you want to exclude
215 the Preloaded Audio format from overlapping with eAudio 
216 you can use the following SQL:
217
218 ----
219 UPDATE config.composite_attr_entry_definition SET definition = '{"0":{"_attr":"item_type","_val":"i"},"1":[{"_attr":"item_form","_val":"o"},{"_attr":"item_form","_val":"s"}]}'
220     WHERE coded_value IN (SELECT id FROM config.coded_value_map WHERE code = 'eaudio');
221 ----
222
223 It is also recommended that you reingest your bibliographic records 
224 to updated the fixed field indexes. You can accomplish this by running
225 the following query in your database:
226
227 ----
228 SELECT metabib.reingest_record_attributes(source)
229 FROM metabib.record_attr_vector_list WHERE
230 (SELECT id FROM config.coded_value_map WHERE ctype = 'item_form' AND code = 'q') = ANY(vlist)
231 AND (SELECT id FROM config.coded_value_map WHERE ctype = 'item_type' AND code = 'i') = ANY(vlist);
232 ----
233
234
235
236
237
238 === API ===
239
240
241
242 ==== Override Label for draw_field_label Patron Edit Fields ====
243
244 Evergreen developers may now specify a label for fields in
245 the patron registration/patron edit form (generated by
246 the draw_field_label macro). By default, 
247 draw_field_label uses the label of supplied IDL field class. 
248 Now a developer may supply an additional third parameter,
249 label_override, which overrides the default IDL-based label.
250 This would typically be done in the course of customizing
251 the web staff client template `circ/patron/t_edit.tt2`.
252
253
254
255
256 === Architecture ===
257
258
259
260
261 ==== New Action/Trigger reactor for 3rd party signaling ====
262
263 This new Action/Trigger reactor module allows an Evergreen administrator to
264 create event defintions that use HTTP (or HTTPS) to contact external services
265 and let them know that something has happened in Evergreen.
266
267 For instance, a discovery layer can be informed when a bib record is updated
268 or when a user's barcode changes.
269
270 ===== Reactor Template Syntax =====
271
272 The new reactor module uses a template to define its behavior.  While the
273 template is processed by Template Toolkit, as with any A/T templates, its
274 output format is new to Evergreen.
275
276 The template should output data that can be parsed by the Config::General Perl
277 module.  See: https://metacpan.org/pod/Config::General
278
279 Top level settings should include the HTTP *method* and the *url*.
280
281 A block called *Headers* can be used to supply arbitrary HTTP headers.
282
283 A block called *Parameters* can be used to append CGI parameters to the URL,
284 most useful for GET form submission.  Repeated parameters are allowed.  If
285 this block is used, the URL should /not/ contain any parameters, use one or
286 the other.
287
288 A HEREDOC called *content* can be used with POST or PUT to send an arbitrary block
289 of content to the remote server.
290
291 If the requested URL requires Basic or Digest authentication, the template can
292 include top level configuration parameters to supply a *user*, *password*, *realm*,
293 and hostname:port *location*.
294
295 A default user agent string of "EvergreenReactor/1.0" is used when sending requests.
296 This can be overridden using the top level *agent* setting.
297
298 Here is an example template that could be used by a definition attached to the
299 *bib.edit* hook:
300
301 [source,conf]
302 ----
303 method   post # Valid values are post, get, put, delete, head
304 url      https://example.com/api/incoming-update
305 agent    MySpecialAgent/0.1
306
307 user     updater
308 password uPd4t3StufF
309 realm    "Secret area"
310 location example.com:443
311
312 <Headers>
313   Accept-Language en
314 </Headers>
315
316 <Parameters>
317   type bib
318   id   [% target.id %]
319 </Parameters>
320
321 content <<MARC
322 [% target.marc %]
323 MARC
324 ----
325
326
327
328
329
330 ==== Documentation Now Uses the Antora Toolchain ====
331
332 The core Evergreen documentation under the `docs/` subdirectory
333 has been changed to use Antora, a documentation site generator
334 for AsciiDoc. The result of this change is the ability to generate
335 documentation for the `docs.evergreen-ils.org` website that is
336 searchable, easier to maintain, and readily installable on a
337 local Evergreen site if desired.
338
339 For instructions on how to build the documentation, consult
340 the file `README.adoc` under the `docs` directory.
341
342
343
344
345 === Cataloging === 
346
347
348
349 ==== Manage Authorities Angular Port ====
350
351 The Cataloging -> Manage Authorities interface has been ported to Angular.
352
353 New functionality includes displaying additional authority data, like create
354 and edit dates, etc.  It's also possible to view the list of linked bib
355 records.
356
357
358
359
360 ==== MARC Batch Edit UI Angular Port ==== 
361
362 The MARC Batch Edit interface has been ported to Angular.
363
364
365
366
367 ==== Preloaded Audio Icon and Search Format ====
368
369 A new search and icon format called Preloaded Audio now exists 
370 using the following atttributes: itemtype i, item form q.  This 
371 overlaps with the eAudio format.  If you want to exclude 
372 preloaded audio from eAudio there is a script in the Administration 
373 notes to exclude it. 
374
375
376
377
378 ==== Item Status Allows Pasting a List of Barcodes in csv Format ====
379
380 The item status input box will now accept a string of barcodes, separated with commas, as well as a single barcode.
381
382
383
384
385
386 === Circulation ===
387
388
389
390 ==== Booking Capture is now in Angular ====
391
392
393 The interface to capture resources for booking
394 reservations has been re-implemented in Angular.
395 Other booking screens, such as Pick Up and
396 Manage Reservations, now include an option to 
397 re-print capture slips.
398
399 System administrators can now edit the template
400 for booking capture slips in Administration ->
401 Server administration -> Print templates.
402
403
404
405
406
407 ==== New Fields for AutorenewNotify Event Template ====
408
409
410 Two new fields, `auto_renewal_remaining`, and `total_renewal_remaining` have
411 been added to the AutorenewNotify action/trigger event code.  They will
412 report the number of autorenewals and regular renewals, respectively,
413 remaining on the new circulation if renewed, or on the old circulation
414 if not renewed.  This is provided as a convenience to avoid possibly
415 inaccurate math in the template.  You may access them in the template via
416 the `udata`:
417
418 ----
419 Automatic Renewals Remaining: [% udata.auto_renewal_remaining %]
420 Total Renewals Remaining: [% udata.total_renewal_remaining %]
421 ----
422
423
424
425
426
427 ==== Course materials module ====
428
429 This version of Evergreen includes an optional course materials module.
430 Like course reserves modules in other library software, this module
431 makes reserves collections more discoverable and easier to manage.
432 The module also provides similar functionality for library electronic
433 resources and open educational resources, whether they have been
434 cataloged or not.
435
436 To enable the course materials module, go to Administration ->
437 Local Administration -> Library Settings Editor. Find the setting
438 called "Opt Org Unit into the Course Materials Module".  Set it to
439 True for the org units that want to use the module.
440
441 To use the course materials module effectively, staff will need a
442 new permission called _MANAGE_RESERVES_.  By default, circulation
443 administrators will receive this permission.
444
445 ===== Courses =====
446
447 Staff members with the _MANAGE_RESERVES_ permission can create
448 courses, attach materials to them, attach users to them, and
449 archive them when they are no longer needed.
450
451 When associating physical materials from the catalog to a
452 course, staff members can choose temporary item attributes.
453 These attributes will last until the course is archived or
454 the item is detached from the course, whichever happens
455 first.
456
457 Staff can also choose to associate electronic resources from
458 the catalog (which must have a transcendent bib source or
459 a located URI).  They can also create a brief bib record
460 to attach to the course from within the course materials
461 module.
462
463 Staff members can attach users to the course.  These users
464 can have either a public role (e.g. instructor) or private
465 roles (e.g. student).  The public roles will be displayed
466 in the OPAC.
467
468 ===== OPAC =====
469
470 If the module is enabled, the OPAC will include a course search
471 and a course browse.
472
473 ===== Other uses =====
474
475 Libraries may also want to use this module to manage their
476 displays.  Each display can be treated as a course, and staff
477 can attach the items they wish to display to the course along
478 with the temporary attributes (e.g. a shelving location called
479 "On display").  When the display is over, staff members can
480 archive the course.
481
482
483
484
485
486 ==== Hopeless Holds Interface ====
487
488 A new interface under Local Administration has been added called
489 Hopeless Holds.  Using a new Hopeless Date field on hold requests,
490 this interface gives staff a way to resolve issues with hold
491 requests that may have become unfulfillable or "hopeless".
492
493 The Hopeless Date is set for a given request by the hold targeter
494 whenever the potential items list for the hold is empty, or when
495 all potential items have a copy status that has been designated
496 as Hopeless Prone (a new boolean field on Item Statuses).
497
498
499
500
501
502 ==== In-house use now records workstations ====
503
504 Evergreen now records the workstation along with each
505 in-house use.  Staff can now run reports on which
506 workstation created which in-house use.
507
508
509
510
511 ==== Option to Make Effective Date of Checkin Sticky ====
512
513 Adds a checkbox to the Checkin screen that will make the backdate effective until logout.
514
515
516
517
518 ==== Purge User Preferred Names ====
519
520 The new, user preferred name fields are now set to NULL in the
521 database when a user account is purged via the staff client or using
522 the actor.usr_delete function in the database.
523
524 To clear the preferred name fields from records that have already been
525 purged, run the following SQL update:
526
527 [source,sql]
528 ----
529 UPDATE actor.usr
530 SET pref_prefix = NULL,
531     pref_first_given_name = NULL,
532     pref_second_given_name = NULL,
533     pref_family_name = NULL,
534     pref_suffix = NULL,
535     name_keywords = NULL
536 WHERE usrname ~ ('^' || id || '-PURGED')
537 AND NOT active
538 AND deleted
539 AND (
540   pref_prefix IS NOT NULL OR
541   pref_first_given_name IS NOT NULL OR
542   pref_second_given_name IS NOT NULL OR
543   pref_family_name IS NOT NULL OR
544   pref_suffix IS NOT NULL OR
545   name_keywords IS NOT NULL
546 );
547 ----
548
549
550
551
552 ==== Test Notification Method ====
553
554 Patrons and staff may request a test notification for a patron's default email address or SMS 
555 number via the Patron Registration interface in the staff client or the Opac preferences interface. The OPAC_LOGIN permissions are required to 
556 request a notification. When a notification is sent, it will be sent to either the user's default email or default SMS number, depending on 
557 what was requested.
558
559 ===== Upgrade Notes =====
560
561 This feature adds two new rows to action_trigger.event_definition, two into 
562 action_trigger.hook, and six into action_trigger.environment.
563
564
565
566 ==== Curbside Pickup ====
567
568 The Curbside Pickup features in Evergreen provides an interface to help
569 facilitate contact-free pickup of library materials.  It provides a dedicated
570 interface in the staff client for library staff to track and manage curbside
571 pickup appointments and materials through the various stages of the process.
572 Staff can also schedule pickup appointments on behalf of patrons.  This feature
573 also allows patrons to schedule their own curbside pickup appointments in their
574 OPAC account, as well as inform the library when they have arrived and are
575 waiting for their materials.  
576
577 This is an extension of the existing holds functionality in Evergreen.  A hold
578 must be placed for an item to be eligible for curbside pickup.  After an item
579 has been captured for a hold and is available for pickup from the holds shelf,
580 a curbside pickup appointment can be scheduled to allow the materials to be
581 obtained in a contact free transaction.
582
583 It can accommodate several different workflows depending on how the library
584 decides to implement curbside pickup.  It can help library staff track and
585 checkout batches of items to be picked up curbside and help facilitate
586 communication between library staff and patrons.  It does not prescribe a
587 specific workflow for curbside pickup.
588
589 It can be used alongside regular (in the library) hold pickup.  Curbside pickup
590 can be an option offered patrons in addition to regular pickup or it can
591 be the primary pickup option depending on the library’s current service plan.
592
593 It assumes the library will have a staff member assigned to managing curbside
594 pickup throughout the day.
595
596 ===== Library Settings =====
597
598 This feature adds the following library settings.
599
600  * `circ.curbside`: whether to enable curbside appointments for
601    picking up available hold requests. This defaults to off.
602     
603  * `circ.curbside.granularity`: interval between appointment slots. This
604    defaults to 15 minutes.
605  
606  * `circ.curbside.max_concurrent`: how many appointments to permit per
607    time slot.  This defaults to 10.
608
609  * `circ.curbside.disable_patron_input`: if turned on, display scheduled
610     and pending appointments in My Account in the public catalog but
611     do not give the patron the ability to change them from My Account.
612     This defaults to false, i.e., allowing patrons to modify appointments
613     from My Account.
614
615 ===== Notifications And Action Triggers =====
616
617 There are several new patron notice options related to curbside pickup. 
618
619 When a patron’s holds are marked as ready for pickup in Evergreen, an email or
620 text/SMS notification can be sent to let them know that curbside pickup is an
621 option at their library.  This notice can be used to promote this service and
622 the default message will prompt patrons to log in to their OPAC account to
623 schedule an appointment or call the library to schedule an appointment.
624 Notice message is customizable.  The Trigger Event Definitions for this notice
625 are called:
626
627  * Curbside offer Email notification, triggered by CurbsideSlot reactor on a
628    definition attached to the hold available hook
629  * Curbside offer SMS notification, triggered by CurbsideSlot reactor on a
630    definition attached to the hold available hook
631
632 If a patron has scheduled a curbside pickup appointment, an email or text/SMS
633 notification can be sent to confirm the appointment.  It will also prompt them
634 to log into their account or call the library when they have arrived for their
635 pickup appointment.  The Trigger Event Definitions for this notice are called:
636
637  * Curbside confirmation Email notification
638  * Curbside confirmation SMS notification
639
640 Patrons can receive an email with a list of the items they checked out.  To
641 receive this notice patrons must have an email address associated with their
642 account and the option for “Email checkout receipts by default?” must be
643 selected in their account.  This is an existing notice in Evergreen that ties
644 in to the curbside pickup workflow.
645
646 There is another action trigger called “Trigger curbside offer events and
647 create a placeholder for the patron, where applicable”.  This action trigger
648 does not send a notice to patrons or staff.  It is a silent action behind the
649 scenes that initiates the curbside offer email or SMS notification described
650 above.  
651
652 ===== Upgrade Notes =====
653
654 This feature adds a new OpenSRF service, `open-ils.curbside`, which must be
655 enabled and registered with the public router for the feature to function.
656
657 This feature adds no new staff permissions.
658
659
660
661 ==== Allow Use of Adjusted Proximity for Age-protection ====
662
663 Introduces a new library setting to consult adjusted proximity for age-protected items at hold placement time.
664
665
666
667
668 === Client ===
669
670
671
672 ==== New Angular Staff Catalog Default ====
673
674 The experimental Angular staff catalog has been promoted to operate as the
675 default catalog in the browser staff client.  It will be used for all 
676 catalog entry points, except for the menu entries for the traditiaional
677 catalog and any links within the traditional catalog.
678
679 ===== Menu Changes =====
680
681 * Search -> 'Search The Catalog' now searches to new catalog.
682 * Cataloging -> 'Search The Catalog' now searches to new catalog.
683 * Cataloging -> 'Search The Catalog (Traditional)' searches the traditional 
684   TPAC-style catalog.
685 * Staff client splash page -> 'Search the catalog' inline form uses the 
686   new catalog.
687
688
689
690
691
692 ==== Basket To Bucket Action Now Allows Adding To Shared Buckets ====
693
694 The Angular staff catalog's 'Add Basket to Bucket' action now
695 gives the user the option of adding the contents of the basket
696 to a shared bucket.
697
698
699
700
701
702 === OPAC ===
703
704
705 ==== New Bootstrap-based OPAC ====
706
707
708 This release includes a new experimental OPAC with a cleaner, more modern design.
709
710 To enable the new OPAC design, open the `/etc/apache2/eg_vhost.conf` file.
711
712 Find the following line:
713
714 ----
715 PerlAddVar OILSWebTemplatePath "/openils/var/templates"
716 ----
717
718 Add the following line directly below it:
719
720 ----
721 PerlAddVar OILSWebTemplatePath "/openils/var/templates-bootstrap"
722 ----
723
724 Be sure that, if you have any local customizations, that they are referenced below
725 this line.  This way, your customizations will still appear in the new OPAC design
726 (although they may need to be adjusted to better fit the new style).
727
728 You can also turn on the new OPAC for some virtual hosts only, by adding it to the
729 appropriate virtual host entry.  Be sure to reference the OILSWebTemplatePath for
730 the `templates-bootstrap` directory before referencing any local customizations
731 used by that virtual host.
732
733 To emphasize, the new OPAC skin is considered experimental for 3.6.x. There
734 are some discrepancies between its functionality and the functionality
735 present in the original "TPAC" skin. The Evergreen community aims to
736 resolve those discrepancies and make the Bootstrap skin become the default
737 OPAC for the Spring 2021 release (though the original TPAC skin will still
738 be available). Using the Bootstrap skin in production for 3.6 is at your own risk.
739
740
741
742
743 ==== Enhanced Public Catalog Printing and Email ====
744
745 Evergreen now provides additional functionality for printing and emailing
746 bibliographic record and holdings information from the catalog, including
747 from an individual record or from a list or basket.
748
749 After selecting Print or Email, the user will be presented with a preview of
750 the printout or email, respectively.  From the preview users can chose to view
751 Brief or Full record information (Full includes holdings information) and how
752 records should be sorted (Author, Title, Publication Date).  Holdings
753 information can also be limited to a certain library.
754
755 Users can be required to log in to their OPAC account to send an email or this
756 feature can be configured to allow sending an email without signing in to the
757 public catalog. If the option to allow emailing without signing in is enabled
758 (by turning on the new 'Allow record emailing without login' library setting),
759 user will be asked to solve an arithmetic CAPTCHA in order to send the email.
760
761 ===== Administration =====
762
763 Two new interfaces have been added to Local Administration: Event Definition
764 Groups and Event Definition Group Members.  The Event Definition Groups defines
765 the various groups for Action Trigger Event Definitions -- currently Print
766 Record(s) or Email Record(s).  The Event Definition Group Members defines the
767 options within each group -- currently Brief or Full record information.
768
769 These two interfaces expose the infrastructure behind the new print and
770 email functionality and library staff will not need to make any changes to
771 these interfaces to use the existing print and email options.  The stock print
772 and email Action Trigger Event Definitions can be cloned and modified to
773 provide additional bibliographic format options.  After creating the custom
774 Event Definition, add it to the appropriate Event Definition Group (Print
775 Record or Email Record) and the new format will be available in the catalog.
776
777
778
779
780
781 ==== Credit card payments using Stripe now on version 3 (Elements) ====
782
783 When Stripe payments are enabled, the public catalog will now
784 use version 3 of the Stripe client library, as well as its
785 Elements API for building the credit card form.  For
786 technical reasons, this more easily lends a site to PCI
787 compliance.
788
789 On the staff side, the credit card option is disabled for
790 Stripe, as that has not been implemented and in the past
791 would just give an error.
792
793
794
795
796 ==== Improve Access to Libray Info in OPAC ====
797
798 Adds the library's address, email, phone, and website link to the myopac patron account preferences page.
799
800
801
802
803 === Reports ===
804
805
806
807 ==== Combined Aged and Active Circluations Source Naming ==== 
808
809 A recent improvement to aid web client data retrieval
810 speed resulted in a new reports source that was named
811 nearly identically to a long-existing one, and both
812 were appearing in the "Core Sources" section of reports.
813 The newer source has been renamed for clarity and removed
814 from the core sources to prevent confusion:
815
816  * "Combined Aged and Active circulations" is now named "Combined Aged and Active Circulations (Slim Version)"
817    and is removed from the Core Sources.
818  * "Combined Aged and Active Circulations", which contains more linkages to other data sources, remains in the 
819    Core Sources list.
820
821
822
823
824 ==== Reports Subtotals ====
825
826 Reports now allow group subtotals and grand totals.  By checking the
827 new "Calculate grouping subtotals" checkbox under "Output Options",
828 a new unlabeled row or column is created with the subtotals for each
829 grouping and an unlabeled grand total row or column.
830
831 This takes advantage of PostreSQL's built-in ROLLUP feature.  See the
832 PostgreSQL documentation for details: 
833
834 https://www.postgresql.org/docs/9.6/queries-table-expressions.html#QUERIES-GROUPING-SETS
835
836 An example of a report that could use this new feature is
837 one based on the Circulation source with the following fields:
838
839  * Circulation -> Checkout / Renewal Library -> Short (Policy) Name (Raw Data)
840  * Circulation -> Checkout Date/Time (Year)
841  * Circulation -> Shelving Location -> Name (Raw Data)
842  * Circulation -> Circ ID (Count Distinct)
843
844 Turning on the "Calculate grouping subtotals" checkbox would make
845 the report show subtotals for each combination of
846 short name, checkout year, and shelving location name.
847
848
849
850
851 === SIP ===
852
853
854
855 ==== Allow Username in Patron ID ====
856
857 Evergreen now accepts a patron's username in the SIP2 Patron ID field
858 (AA) in addition to the barcode.  This modification is useful for
859 vendors, such as Overdrive, who can accept a user's username.
860 Additionally, it is easier for a patron to find and remember their
861 username over their barcode.
862
863 The new feature determines if the value in the Patron ID field is a
864 barcode or username by comparing the field value against the
865 `opac.barcode_regex` setting for the organizational unit of the logged
866 in SIP2 account as configured in the oils_sip.xml file.  This is
867 similar to what the OPAC does when a patron logs in.
868
869 This feature requires activation.  To activate, uncomment (or add) the
870 following line in the oils_sip.xml configuration file and change the 
871 value from 'false' to 'true'.
872
873 [source,xml]
874 ----
875 <option name='support_patron_username_login' value='true' />
876 ----
877
878
879
880 == Acknowledgments ==
881
882 The Evergreen project would like to acknowledge the following
883 organizations that commissioned developments in this release of
884 Evergreen:
885
886 * C/W MARS
887 * Evergreen Community Development Initiative
888 * Georgia Public Library Service
889 * Indiana State Library
890 * Linn-Benton Community College
891 * MassLNC
892 * NOBLE
893 * PaILS
894 * Treasure Valley Community College
895
896 We would also like to thank the following individuals who contributed
897 code, translations, documentation, patches, and tests to this release of
898 Evergreen:
899
900 * John Amundson
901 * Nelson Appell
902 * Zavier Banks
903 * a. bellenir
904 * Felicia Beaudry
905 * Jason Boyer
906 * Dan Briem
907 * Chris Burton
908 * Steven Callender
909 * Galen Charlton
910 * Garry Collum
911 * Dawn Dale
912 * Jeff Davis
913 * Diane Disbro
914 * Bill Erickson
915 * Jason Etheridge
916 * Lynn Floyd
917 * Ruth Frasur
918 * Blake Graham-Henderson
919 * Rogan Hamby
920 * Elaine Hardy
921 * Kyle Huckins
922 * Angela Kilsdonk
923 * Owen Leonard
924 * Troy Leonard
925 * Shula Link
926 * Tiffany Little
927 * Mary Llewellyn
928 * Terran McCanna
929 * Gina Monti
930 * Christine Morgan
931 * Michele Morgan
932 * Andrea Buntz Neiman
933 * Jennifer Pringle
934 * Mike Risher
935 * Mike Rylander
936 * Jane Sandberg
937 * Dan Scott
938 * Chris Sharp
939 * Remington Steed
940 * Jason Stephenson
941 * Josh Stompro
942 * Dan Wells
943 * Jennifer Weston
944 * Beth Willis
945 * John Yorio
946
947 We also thank the following organizations whose employees contributed
948 patches:
949
950 * Ann Arbor District Library
951 * BC Libraries Cooperative
952 * Bibliomation
953 * Calvin College
954 * Catalyte
955 * C/W MARS
956 * Equinox Open Library Initiative
957 * Georgia Public Library Service
958 * Grand Rapids Public Library
959 * Greater Clark Hills Regional Library System
960 * Indiana State Library
961 * Kenton County Public Library
962 * King County Library System
963 * Laurentian University
964 * Linn-Benton Community College
965 * MOBIUS
966 * Niagara Falls Public Library
967 * NOBLE
968 * Scenic Regional Library
969 * Sigio
970 * Washington County (MO) Public Library
971 * Westchester Library System
972 * Zivot Design
973
974 We regret any omissions.  If a contributor has been inadvertently
975 missed, please open a bug at http://bugs.launchpad.net/evergreen/
976 with a correction.
977