Docs: adding translators to 3.2 release notes
[Evergreen.git] / docs / RELEASE_NOTES_3_2.adoc
1 Evergreen 3_2 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Upgrade notes
7 -------------
8
9 New Features
10 ------------
11
12
13
14 Acquisitions
15 ~~~~~~~~~~~~
16
17
18
19 Auto-Cancel Lineitems When All Copies Are Canceled
20 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21 When a copy (lineitem detail) is canceled through the Acquisitions interface, 
22 the parent lineitem is also canceled if all copies for that lineitem are also 
23 canceled.  The cancel reason given will come from:
24
25 1. The cancel reason for the just-canceled copy if it's a Keep Debits true 
26    cancel reason.
27 2. The cancel reason from any other copy on the lineitem that has a Keep 
28    Debits true cancel reason.
29 3. The cancel reason for the just-canceled copy if no copies have a Keep
30    Debits true cancel reason.
31   
32
33
34
35
36 Invoice Closed Date and Closed By Fields
37 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
38 Acquisitions invoices have 2 new fields:
39
40 * Close Date -- This is set to the time when the ACQ user clicks the "Close"
41   button in the invoice interface.
42   ** This field 'replaces' the existing 'complete' field.  An invoice is
43      considered complete if a close date value is set.
44 * Closed By -- This is set to the logged in staff user who performs the 
45   "Close" action.
46
47 As with the now-defunct 'complete' field, but new fields are cleared in the 
48 event an invoice is reopened.
49
50 These new fields are visible in the invoice interface under the 
51 'Show Details' action for closed invoices.
52
53 Upgrading Invoice Reports
54 +++++++++++++++++++++++++
55
56 Existing report templates that reference the invoice 'complete' field 
57 should be modified to check whether the new close_date field is NOT NULL
58 instead.
59
60 Other Upgrade Considerations
61 ++++++++++++++++++++++++++++
62
63 At deploy time, all invoices with a 'complete' value of TRUE will have their
64 'close_date' field set to NOW.  A value is required, since this field is
65 now the source of whether an invoice is open or closed.
66
67 However, no values will be applied to the closed_by field for already closed
68 invoices.
69
70
71
72
73
74
75 Patron Acquisitions Requests
76 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77
78 The existing interface for staff-mediated patron acquisition requests has been replaced in the web staff client with a re-implementation written in AngularJS, with some minor bug fixes (including access from the Patron interface) and other improvements.
79
80
81
82
83
84 Cataloging
85 ~~~~~~~~~~
86
87
88
89 Add UPC to z39.50 search for OCLC and LOC
90 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91 Add UPC as a search attribute for both OCLC and LOC targets in
92 z39.50 for cataloging.
93
94
95
96
97 Asynchronous Vandelay Imports
98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99
100 Vandelay imports are now monitored from the browser client asynchronously,
101 meaning the client requests updates from the server instead of waiting for 
102 the server to respond to the original import request.  This changes allows 
103 for incremental progress updates in the browser client.
104
105 New Database Table
106 ++++++++++++++++++
107
108 This adds a new database table vandelay.session_tracker for tracking
109 in-progress vandelay upload activity.  A new tracker row is added for
110 each of "upload", "enqueue", and "import" actions, linked for a given
111 session by the value stored in the "session_key" field.
112
113 The table tracks other potentially useful data, like the staff member
114 and workstation where the action was performed.
115
116 Upgrade notes
117 +++++++++++++
118 Users of NGINX as a reverse proxy may need to set a suitable
119 `client_max_body_size` value in the NGINX configuration so that large
120 MARC record uploads are not truncated. Note that this would have
121 always been necessary, but since this feature allows larger files
122 to be more reliably queued and imported, the need to set `client_max_body_size`
123 became more apparent.
124
125
126
127
128 Support for Last Inventory Date
129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
130 Evergreen now provides an option to add an inventory date to items to facilitate
131 the process of performing inventory in libraries. Staff can add an inventory
132 date to an item in one of the following ways:
133  * From the check in screen, there is now an Update Inventory check in modifier.
134 When selected, scanned barcodes will have the current date/time added as the
135 inventory date while the item is checked in.
136  * From the Item Status screen, an action is available to add the current 
137 date/time as the inventory date to selected items.
138
139 This new feature will also store the workstation that was used when the
140 inventory date was updated.
141
142
143
144
145
146 Parallel Ingest with pingest.pl
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
148 A program named pingest.pl is now installed to allow faster record
149 ingest.  It performs ingest in parallel so that multiple batches can
150 be done simultaneously.  It operates by splitting the records to be
151 ingested up into batches and running all of the ingest methods on each
152 batch.  You may pass in options to control how many batches are run at
153 the same time, how many records there are per batch, and which ingest
154 operations to skip.
155
156 NOTE: The browse ingest is presently done in a single process over all
157 of the input records as it cannot run in parallel with itself.  It
158 does, however, run in parallel with the other ingests.
159
160 Command Line Options
161 ++++++++++++++++++++
162 pingest.pl accepts the following command line options:
163
164 --host::
165     The server where PostgreSQL runs (either host name or IP address).
166     The default is read from the PGHOST environment variable or
167     "localhost."
168
169 --port::
170     The port that PostgreSQL listens to on host.  The default is read
171     from the PGPORT environment variable or 5432.
172
173 --db::
174     The database to connect to on the host.  The default is read from
175     the PGDATABASE environment variable or "evergreen."
176
177 --user::
178     The username for database connections.  The default is read from
179     the PGUSER environment variable or "evergreen."
180
181 --password::
182     The password for database connections.  The default is read from
183     the PGPASSWORD environment variable or "evergreen."
184
185 --batch-size::
186     Number of records to process per batch.  The default is 10,000.
187
188 --max-child::
189     Max number of worker processes (i.e. the number of batches to
190     process simultaneously).  The default is 8.
191
192 --skip-browse::
193 --skip-attrs::
194 --skip-search::
195 --skip-facets::
196 --skip-display::
197     Skip the selected reingest component.
198
199 --start-id::
200     Start processing at this record ID.
201
202 --end-id::
203     Stop processing when this record ID is reached.
204
205 --pipe::
206     Read record IDs to reingest from standard input.  This option
207     conflicts with --start-id and/or --end-id.
208
209 --max-duration::
210     Stop processing after this many total seconds have passed.  The
211     default is to run until all records have been processed.
212
213 --help::
214     Show the help text.
215
216
217
218
219
220 View Authority Record by Database ID
221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
222
223 A new interface allows catalogers to retrieve a specific
224 authority record using its database ID.  Catalogers can
225 find those IDs in subfield $0 of matching fields in
226 bibliographic records.
227
228 To use the new authority record viewer:
229
230 . Click *Cataloging -> Retrieve Authority Record by ID*.
231 . Type in the ID number of the authority record you are
232 interested in. Don't include any prefixes, just the ID
233 number.
234 . Click *Submit*.
235 . View or edit the authority record as needed.
236
237
238
239
240
241 Circulation
242 ~~~~~~~~~~~
243
244
245
246 Autorenewal of Loans
247 ^^^^^^^^^^^^^^^^^^^^
248 Circulation policies in Evergreen can now be configured to automatically renew
249 certain items checked out on patron accounts. Circulations will be renewed
250 automatically up to a custom limit (the `max_auto_renewal` field) and patrons
251 will not need to log in to their OPAC accounts or ask library staff to manually
252 renew materials.
253
254 Two new action triggers have been added to Evergreen that permit the Auto-Renew
255 feature. They can be found, configured, and enabled in Administration>Local
256 Administration>Notifications/Action Triggers. They are named **Autorenew** and
257 **AutorenewNotify**.
258
259 The **Autorenew** A/T definition uses the `checkout.due` hook to automatically
260 validate and renew (in the reactor) circulations on the day they are due,
261 grouped by user. The output events of this definition is is the input used by
262 the related **AutorenewNotify** A/T that simply uses a new hook called
263 `autorenewal` to notify patrons via email of their currently due or
264 auto-renewed items.
265
266 In the webstaff's Patron Items Out page, the new column `AutoRenewalsRemaining`
267 indicates how many autorenewals are available for a particular circulation.
268
269
270
271
272
273 Emergency Closing Handler
274 ^^^^^^^^^^^^^^^^^^^^^^^^
275
276 Staff are provided with interfaces and mechanisms to create library closings that, in addition to affecting future circulation and booking due dates, and hold shelf expirations, will automatically move existing circulation and booking due dates and hold shelf expiration times. This new functionality is conceptually described as Emergency Closings and business logic implementing it as the Emergency Closing Handler. It contains additions and adjustments to the user interface, business logic, and database layers. Access to this functionality is available through the Closed Dates Editor interface in the staff client which has been ported to AngularJS.
277
278 Overview
279 ++++++++
280
281 This development has created new business logic code to inspect, in real time, existing circulation, booking, and hold records, and modify such date and time stamps so that the circulation, booking, or hold will end in the same state it would have if the closing had existed at the time the circulation or booking occurred, or the hold was placed and captured. Of specific note, hourly loans will have their due date adjusted to be the end of the day following the closing.
282
283 When the Emergency Closing is saved, any fines accrued during the closing may be voided, as settings dictate, with the exception of circulations that have been marked as LOST or LONG OVERDUE. That is, even for LOST and LONG OVERDUE circulations with due dates that fall within the Emergency Closing, no fine adjustment will be applied. Emergency Closing processing is permanent, and cannot be rolled back.
284
285 This functionality is explicitly initiated by staff action. If staff do not request an Emergency Closing, existing circulations, bookings, and holds will not be processed and adjusted. However, if staff request any Closing that starts nearer in time than the length of the longest circulation duration configured for use in the Evergreen instance they will be prompted with the option to create the closing as an Emergency Closing.
286
287 Action/Trigger hooks have been created for circulations and bookings that are adjusted by the Emergency Closing Handler. These will facilitate the creation of notifications to patrons that the due date has changed and to alert them to potential changes in accrued fines.
288
289 Booking start dates are explicitly ignored in this implementation. Because an Emergency Closing is, by its nature, an unexpected event, it will be up to staff to address any bookings which intersect with a new Emergency Closings. Reports can be used to identify booking start dates that overlap with a closing and that may require staff intervention.
290
291 Staff requsting and Emergency Closing must have the new EMERGENCY_CLOSING permission.
292 Some text describing the feature.
293
294
295
296
297
298 Patron Preferred Name and Name Search Keywords
299 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
300
301 Preferred Name
302 ++++++++++++++
303
304 Adds a new set of patron preferred name fields for prefix, first,
305 middle, last, and suffix allowing patrons to provide preferred name
306 information.  Preferred names are optional and each acts as an overlay
307 to the analogous primary name field, making it possible to provide
308 preferred name values for individual fields.
309
310 For example, a patron named William Erickson may have a preferred first
311 name (pref_first_given_name) of Bill, in which case the preferred name
312 would be Bill Erickson.  Note a preferred last name is not required in
313 this case as the code uses primary name values as defaults when not
314 replaced with a preferred version.
315
316 * Patrons will see primary names displayed in the catalog when set.
317 * Staff will see both primary name and preferred name in the patron
318   summary side bar.
319 * Patron searches for any given name field will search both the primary
320   and preferred name data.
321 * Preferred name fields are available in Action/Trigger templates and
322   are present in various patron-focused print templates.
323
324 Name Keywords
325 ++++++++++++++
326
327 Adds a new field to store miscellaneous patron name search terms.  These
328 values are only for searching and do not appear in any interfaces, apart
329 from the patron summary side bar and the patron edit UI.
330
331 Included is a new search field in the patron search UI which searches
332 keyword values and all other name fields.  It's essentially a global patron
333 name keyword search.
334
335
336
337
338 Client
339 ~~~~~~
340
341
342
343 Permission Group Display Entries
344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
345 In some cases, it is useful to have the ability to reorder permission, or to make
346 only specific groups available in the permission group selector for specific
347 Org Units. An interface has been made available to allow this.
348
349 Group Tree Display Entry Interface
350 ++++++++++++++++++++++++++++++++++
351
352 Permission Group Display Entries can be reordered, added, or removed via
353 _Administration -> Local Admin -> Permission Tree Display Entries_.
354 Select the Org Unit you wish to edit the entries in.
355
356 Entries may be added using the Add functionality, creating entries based
357 on permission groups that have not been added to the tree for the Org
358 Unit you wish to add them to.
359
360 image::media/pgtde_01.png[Group Tree Display Entry Admin UI]
361
362 Moving an Entry
363 +++++++++++++++
364 Moving an entry will shift its position up or down in the patron profile
365 selector for a given Org Unit.
366
367 * Select an entry
368 * Press either the *Move Up* or *Move Down* button. The entry will be 
369 moved up or down, accordingly.
370 * Click *Save* to save your edits.  
371
372 NOTE: You may only move up or down entries that have sibling entries.
373
374 Removing an Entry
375 +++++++++++++++++
376 If you want a particular Org Unit to not have access to specific
377 entries, you may remove an entry. Removing an entry will remove it from 
378 view. The entry will be removed from the database.
379
380 * Select an entry and press the *Remove* button.
381
382 Adding an Entry
383 +++++++++++++++
384 You may add entries from permission groups that are not currently
385 reflected in the permission group tree. This is useful for moving 
386 entries to different parents, or making them root entries.
387
388 image::media/pgtde_02.png[Add Entry modal]
389
390 * If desired, select an entry to be used as the parent entry. 
391 * Press the *Add* button. 
392 * Select a permission group from the dropdown.
393 * If you've selected a parent entry, you may check the *Add Root Entry*
394 box to override that parent and add the entry on the root level. 
395 * If you did not select a parent entry, the entry will be added on the root 
396 level of the tree.
397
398
399
400 Browser Client Settings & Preferences Stored on the Server
401 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
402 Browser cilent settings and preferences that should persist over time are
403 now stored as settings on the server.  This allows settings to follow
404 users and workstations and reduces problems associated with losing settings 
405 as a result of clearing browser data.
406
407 The browser client honors setting values stored as user settings, workstation
408 settings, and org unit settings, depending on which setting types are
409 locally configured.
410
411 Setting Types
412 +++++++++++++
413
414 * No setting can be both a user and workstation setting.  They are mutually
415   exclusive.
416 * Any setting can be an org unit setting in addition to being a user or
417   workstaion setting.
418
419 Read-Only Settings
420 ++++++++++++++++++
421
422 Read-only settings are useful for defining values that staff can use but
423 not modify.  For example, admins may wish to prevent users from locally
424 modifying the grid configuration for a given interface so it remains
425 consistent for all users.
426
427 A setting is read-only when an org unit setting type exists (regardless of 
428 whether a value is applied) and no user or workstation setting type exists.
429
430 Server-Stored Workstation Settings Workstation Admin View
431 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
432
433 There's a new "Server Workstation Prefs" tab to the stored preferences
434 workstation admin interface.  From here, users can view which
435 preferences are stored as server-stored workstation preferences and
436 delete select values.
437
438 Upgrade Notes
439 +++++++++++++
440
441 A new permission APPLY_WORKSTATION_SETTING has been added to control who
442 may apply values to workstation settings.  Use something like the following
443 to apply the permission to all staff accounts (mileage may vary):
444
445 [source,sh]
446 --------------------------------------------------------------------------
447 INSERT INTO permission.grp_perm_map (grp, perm, depth) 
448 VALUES (
449     (SELECT id FROM permission.grp_tree WHERE name = 'Staff'), -- name may vary
450     (SELECT id FROM permission.perm_list WHERE code = 'APPLY_WORKSTATION_SETTING'),
451     0 -- or 1, 2, etc.
452 );
453 --------------------------------------------------------------------------
454
455 Workstation setting types matching values previously stored in the browser
456 (via localStorage or Hatch) are created as part of this feature.  During
457 upgrade, admins should consider whether any of these new setting types 
458 should be transferred to user and/or org unit settings instead.  Setting
459 type changes can be made at any time, but when a setting type is deleted
460 all of its data is deleted, so a change in type means re-applying the 
461 settings in the browser client.
462
463 Values stored in the browser will automatically migrate to server settings
464 as each setting is accessed in the browser client.  Once migrated, the
465 in-browser copies are deleted.  
466
467 If a setting type does not exist where the browser expects one, the 
468 value is stored in-browser instead and a warning is issued in the console.
469
470
471
472
473
474
475 OPAC
476 ~~~~
477
478
479
480 Batch Actions In the Public Catalog
481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
482 The public catalog now displays checkboxes on the bibliographic and
483 metarecord constituents results pages. Selecting one or more titles
484 by using the checkboxes will dynamically add those title to the
485 temporary list, which is now renamed the cart.
486
487 Above the results lists there is now a bar with a select-all checkbox,
488 a link to the cart management page that also indicates the number of
489 of titles in the cart, and a link to remove from the cart titles that
490 are selected on the currently displayed results page.
491
492 The search bar now includes an icon of a cart and displays the number
493 of titles currently in the cart. Next to that icon is a menu of cart
494 actions.
495
496 The cart actions available are Place Hold, Print Title Details,
497 Email Title Details, Add Cart to Saved List, and Clear Cart. In the
498 web staff client, the cart actions also include Add Cart to Bucket.
499 When an action is selected from this menu, the user is given an
500 opportunity to confirm the action and to optionally empty the cart
501 when the action is complete. The action is applied to all titles
502 in the cart.
503
504 Clicking on the cart icon brings the user to a page listing the
505 titles in the cart. From there, the user can select specific records
506 to request, print, email, add to a list, or remove from the cart.
507
508 The list of actions on the record details page now provides separate
509 links for adding the title to a cart or to a permanent list.
510
511 The permanent list management page in the public catalog now also
512 includes batch print and email actions.
513
514 Additional information
515 ++++++++++++++++++++++
516 * The checkboxes do not display on the metarecord results page, as
517   metarecords currently cannot be put into carts or lists.
518 * The checkboxes are displayed only if Javascript is enabled. However,
519   users can still add items to the cart and perform batch actions on
520   the cart and on lists.
521 * A template `config.tt2` setting, `ctx.max_cart_size`, can be used to
522   set a soft limit on the number of titles that can be added to the
523   cart. If this limit is reached, checkboxes to add more records to the
524   cart are disabled unless existing titles in the cart are removed
525   first. The default value for this setting is 500.
526
527 Developer notes
528 +++++++++++++++
529
530 This patch adds the the public catalog two routes that return JSON
531 rather than HTML:
532
533 * `GET /eg/opac/api/mylist/add?record=45`
534 * `GET /eg/opac/api/mylist/delete?record=45`
535
536 The JSON response is a hash containing a mylist key pointing to the list
537 of bib IDs of contents of the cart.
538
539 The record parameter can be repeated to allow adding or removing
540 records as an atomic operation. Note that this change also now available
541 to `/eg/opac/mylist/{add,delete}`
542
543 More generally, this adds a way for EGWeb context loaders to specify that
544 a response should be emitted as JSON rather than rendering an HTML
545 page using `Template::Toolkit`.
546
547 Specifically, if the context as munged by the context loader contains
548 a `json_response` key, the contents of that key will to provide a
549 JSON reponse. The `json_response_cookie` key, if present, can be used
550 to set a cookie as part of the response.
551
552 Template Toolkit processing is bypassed entirely when emitting a JSON
553 response, so the context loader would be entirely reponsible for
554 localization of strings in the response meant for direct human
555 consumption.
556
557
558
559
560 New class for searchbar when on the homepage
561 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
562
563 This adds the `.searchbar-home` class to the div that
564 contains the searchbar when on the homepage.  This allows
565 sites to customize the searchbar differently on the
566 homepage than in other places the
567 search bar appears (for example, offering a large,
568 Google-style search bar on the homepage only).
569
570
571
572
573
574 Username Login Hint
575 ^^^^^^^^^^^^^^^^^^^
576 To make customization easier, the username hint on the OPAC login page ("Please
577 include leading zeros...") has been moved to a separate TT2 template.  If you
578 have customized the hint text, you will need to add your modifications to
579 username_hint.tt2.
580
581
582
583 Acknowledgments
584 ---------------
585 The Evergreen project would like to acknowledge the following
586 organizations that commissioned developments in this release of
587 Evergreen:
588
589 TODO
590
591 We would also like to thank the following individuals who contributed
592 code, translations, documentations patches and tests to this release of
593 Evergreen:
594
595 * Eva Cerninakova
596 * Francisco J Guel-Mendoza
597 * Jennifer Pringle
598 * Jane Sandberg
599 * Stephan Woidowski
600
601 We also thank the following organizations whose employees contributed
602 patches:
603
604 TODO
605
606 We regret any omissions.  If a contributor has been inadvertently
607 missed, please open a bug at http://bugs.launchpad.net/evergreen/
608 with a correction.
609