1 Evergreen 2.4 Beta1 Release Notes
2 =================================
9 Custom Toolbar Permissions
10 ~~~~~~~~~~~~~~~~~~~~~~~~~~
11 With the addition of more granular permissions for configuring a custom
12 toolbars, the ADMIN_TOOLBAR permission alone will not allow users to
13 configure a custom toolbar. This permission must now be used in conjunction
14 with one or more of the following permissions:
16 * ADMIN_TOOLBAR_FOR_ORG
17 * ADMIN_TOOLBAR_FOR_USER
18 * ADMIN_TOOLBAR_FOR_WORKSTATION
26 Acquisitions Inline Item Detail View
27 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29 Acquisitions selection lists and purchase order interfaces contain a new link
30 beside each lineitem which, when clicked, creates an inline grid of copies
31 linked to the lineitem. The grid contains the same information that displays
32 in the full copy edit grid (from clicking on the Copies(n) link). However,
33 the inline grid is read-only, so it displays much faster and does not require
34 the user to change visual contexts.
36 Included along the top of the lineitem table is a new 'Expand All' link which,
37 when clicked, expands or collapses the inline grid for all visible lineitems.
39 Acquisitions Lineitem Order Identifiers
40 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42 Staff now have the ability to specify the identifier value to use for
43 lineitems when communicating order information to vendors. This is
44 particularly important when a lineitem has, for example, multiple ISBNs.
45 Determining which ISBN is to act as the "order identifier" allows staff
46 to provide the most accurate order information to vendors.
48 Supported identifier types include ISBN, ISSN, and UPC. Order identifier
49 values are relayed to vendors via EDI and print PO.
53 Two new permissions are added for this feature:
55 * ACQ_SET_LINEITEM_IDENTIFIER
56 ** Allows staff to apply order identifiers to lineitems
57 * ACQ_ADD_LINEITEM_IDENTIFIER
58 ** Implies that new identifiers shall be added to linked bib records,
59 when a linkage exists.
61 Acquisitions Purchase Order and other Interface Improvements
62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67 The following features, which primarily affect the user interface layer,
68 improve Acquisitions work flows.
70 * Avoid double-activation of POs
71 * Disable invoice and cancel options for pending POs
72 * Disable zero-copy checkbox for activated POs
73 * Disable new charges for activated POs
74 * Replace "Shelving Location" with Copy Location
76 * Rearranging "actions" drop-down
77 ** More consistency in actions applying to selected lineitems specifically
78 ** Things moved from the per-lineitem dropdown to the main one when
80 ** Add to PO dialog added
81 ** You can no longer add lineitems to a PO if they're already on one.
82 ** Actions in dropdown now enabled/disabled differently depending on
83 the interface where it appears (PO vs Selection List vs Acq Search etc.)
85 * Batch update for line items
86 ** Apply updates to all copies of all selected line items at once
87 ** Relies on a middle layer method that streams back information that
88 would suit a more asynchronous display in the future (rather than
89 simply reloading the page upon success, which it does now)
90 ** For failure cases, specific information about which line item cannot
91 be updated, and why, is available to the client, although taking
92 best advantage of this information for user-friendly display is left
94 * Add optional fund, circ modifier and collection code fields to distribution
97 Acquisitions MARC Upload Form Persistence
98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99 Adds a two-layer persistence mechanism for the acquisitions MARC file upload
100 interface. A set of org unit settings now exist for managing default values
101 for the interface. Additionally, for each field where no org unit setting
102 value is configured, the last-used value will be persisted locally and re-
103 used with subsequent loads of the interface.
105 Default Number of Acquisitions Copies to Order
106 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107 Acquisitions providers have a new "Default # Copies" field. When the value
108 is set, this number of copies will be automatically added to each lineitem
109 added to a purchase order for the provider. This takes place during PO
110 creation from a selection list or existing bib record and when a lineitem is
111 added to an existing purchase order. If a lineitem already has copies
112 attached, no default copies are added.
119 TPAC is now the default catalog in Evergreen. The default apache configuration
120 now points to TPAC, staff client OPAC options now point to TPAC, and the JSPAC
121 to TPAC toggle has been removed from the portal page.
123 Display alternate graphic (880) fields
124 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126 By default, Evergreen displays alternate graphic fields, if any, for
127 contributors (1xx / 7xx), titles (245), edition statements (250), imprints
128 (260), notes (5xx), subjects (6xx), and series (4xx / 8xx) in search results and record details
129 per the Library of Congress MARC21 specifications:
131 * http://www.loc.gov/marc/bibliographic/bd880.html
132 * http://www.loc.gov/marc/bibliographic/ecbdcntf.html
133 * http://www.loc.gov/marc/bibliographic/ecbdmulti.html (Model A)
137 In general, alternate graphic fields display below the corresponding
138 primary field. One exception is the attribution summary on the record details
139 page, in which the alternate graphic field contents display between the
140 primary field content and the attribution statement. To support CSS
141 customizations, HTML elements for the graphic fields have the class attribute
144 MARC21 Feeds from OpenSearch
145 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
146 In addition to the already supported formats, you can now get raw MARC21 from
147 OpenSearch feeds, à la:
149 http://<host>/opac/extras/opensearch/1.1/-/marc21?searchTerms=piano
152 Options to Hide Some User Preferences
153 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154 The config.tt2 file now provides options to disable phone notification options, password changes, and e-mail address changes in TPAC. These options are useful
155 for libraries that do not do phone notifications and for those that use
156 centralized authentication.
158 Note the ability to disable user name changes is already available through the
159 Library Settings editor.
163 Public copy notes are now visible in TPAC.
167 A number of changes have been made to search to allow more control and improve
168 performance. These changes and their associated configurations are global to
169 the entire system and can not be configured on a per-library basis.
171 Amongst other things the new search code fixes:
173 * Inability to use statuses and locations as part of a larger query
174 * Invalid queries being generated from advanced searches
175 * Some timeouts from backend code taking too long to perform a search
176 * Some filters being one-use only
177 * Negations not working properly where multiple indexes are involved
179 Improvements include:
181 * Exact matches on input should be more likely to float to the top of results
182 * Non-English stemming can be used, alongside or instead of English stemming
183 * Entered search terms can be found across multiple indexes
185 Default configuration is geared towards English but is easily changed. In a
186 production environment changes will likely require re-indexing, however.
188 The upgrade script could be pre-tweaked to install desired configuration before
189 it builds and/or re-builds many of the indexes.
193 One new permission is added for this feature:
195 * ADMIN_INDEX_NORMALIZER
197 Searching for deleted records
198 +++++++++++++++++++++++++++++
199 Evergreen now supports searching for deleted records via the '#deleted'
202 In order to support this, sites must enable the
203 'ingest.metarecord_mapping.preserve_on_delete' internal flag. It is off by
204 default since the ability to search for deleted records requires keeping
205 metarecord mappings around when bibs are deleted, which may not be desirable
206 for the typical site.
208 Two new QP filters: create_date and edit_date
209 +++++++++++++++++++++++++++++++++++++++++++++
210 These filter on the fields of the same name in biblio.record_entry.
214 * create_date(,2013-02-01) => records created before 2013-02-01
215 * create_date(2013-02-01) => records created since 2013-02-01
216 * create_date(2013-02-01,2013-02-28) => records created in Feb 2013
217 * create_date(yesterday) => records since created yesterday
219 Show local call number in TPAC My Lists display
220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
221 If an opac-visible call number exists that is owned by an org unit
222 relevant to the patron, show the most relevant call number label
223 and owning branch name in the My Lists display for each record in
224 the list. Call number is displayed in both saved and temporary lists.
226 A call number is considered relevant if its owner is one of:
228 physical location library
229 preferred library (plib, home, etc.)
232 If no relevant call number is found, no call number is displayed.
234 TPAC Google Books preview
235 ^^^^^^^^^^^^^^^^^^^^^^^^^
236 Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2`
237 configuration file will cause the TPAC to check to see, as part of the record
238 details view, if Google Books has an online preview available. If it does,
239 then a preview button will be displayed in the book cover image location.
240 If the user then clicks the preview button, the preview will load below the
241 title of the book in the record details page.
243 By default, this functionality is disabled to protect the privacy of users
244 who might not want to share their browsing behavior with Google.
248 Adds support for the opac.org_unit_hiding.depth org unit setting to
249 TPAC, which makes out-of-scope org units disappear (except when
250 explicitly requested).
252 Org unit hiding is based on the physical_loc (Physical Location) param /
253 cookie, which is the closest analog to 'ol' (original location), from
254 which it was based in the JSPAC.
259 * All search org unit selectors
260 * Holds pickup lib selector
261 * Copy summary in search results page
262 * Copy list in search results page
263 * Copy summary in record detail page (which controls the copy grid).
264 * Hold summary in record detail page
269 MARC Import Tag Stripping
270 ^^^^^^^^^^^^^^^^^^^^^^^^^
271 Administrators can configure MARC tags which are removed from MARC records
272 imported via Z39.50 and the Vandelay MARC Import/Export UI (ACQ and non-ACQ).
273 Tags are organized into groups. Groups can be marked as optional or required.
274 For each tag, every instance of the tag (including all subfields) are removed
277 MARC fields which are contained within required ('always_apply') tag groups
278 are always removed from inbound records. No action is needed. Tag groups
279 which are optional will appear in MARC import interfaces (see below) allowing
280 staff to select which groups of tags to strip from incoming records at import
287 ** Admin => Server Administration => MARC Import Remove Fields
289 ** Cataloging => Import Record from Z39.50
290 ** Optional groups appear with the other import options
292 ** Cataloging => MARC Import/Export (Vandelay)
293 ** Acquisitions => Load Order Records
294 ** Optional groups appear with the other import options
298 Three new permissions are added for this feature:
300 * CREATE_IMPORT_TRASH_FIELD
301 * UPDATE_IMPORT_TRASH_FIELD
302 * DELETE_IMPORT_TRASH_FIELD
304 Vandelay Default Match Set
305 ^^^^^^^^^^^^^^^^^^^^^^^^^^
306 A new org unit setting to specify a default Record Match Set when
307 importing MARC records through the MARC Batch Import/Export interface. It does
308 not affect the default match set selected in acquisitions. If this
309 is set, it will not be possible to leave the Record Match Set field blank;
310 it may be necessary to define a default match set that replicates the current
313 A new "Vandelay" org unit settings group is also created.
315 Direct access to Item Attribute Editor
316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
317 You can now access the item attribute editor via Admin -> Local Admin -> Item
318 Attribute Editor. No copy record is loaded into the editor, but it is available to without first finding an item and loading it into the editor:
320 * Configure copy templates.
321 * Hide fields in the copy editor.
326 Clickable Patron Indicators
327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
328 When retrieving a patron record, staff can now click on the indicators listed
329 beneath the patron's name and launch the related tabs.
331 For example, clicking on (See Notes) will open the associated patron's notes.
333 "Warn patrons when their account is about to expire"
334 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
335 To give staff the ability to warn patrons when their account is about to
336 expire, the staff client can display an alert message on the patron information
337 window. A new library setting, `Warn patrons when their account is about to
338 expire` in the *Circulation* section of the *Library Settings Editor*,
339 determines how many days in advance of a patron's account expiry date the alert
340 should be displayed. By default, warnings about upcoming patron account expiry
341 dates are not displayed.
343 Show Hold Patron Name in TPAC
344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
345 When looking up patron information for hold placement via the staff client in
346 TPac, the hold patron name is now shown next to the entered barcode. In the
347 event that the barcode is not found, a notice is displayed and the submit
348 button is disabled until a valid barcode is entered or the staff member is
351 Show Holds On Bib Menu Option
352 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
353 Add direct "Show holds on bibs" menu option from item checkin, item status,
354 and patron hold interfaces. This gives staff a quicker way of viewing who
355 else has holds on an item instead of having to click an option to view the
356 bib record, then clicking into the menus to view holds.
361 Calculated Proximity Adjustments
362 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
363 Allows customization to the way that Evergreen measures the distance between
364 org units for the purposes of 1) determining what copy at what org unit is best
365 suited for targeting a title-level hold, and 2) determining what hold is best
366 suited for fulfillment by a copy-in-hand at capture (checkin) time. The
367 customization is based on a table 'actor.org_unit_proximity_adjustment', with
368 certain matching criteria that the system compares to properties of the holds
369 and copies in question.
373 One new permission is added for this feature:
375 * ADMIN_PROXIMITY_ADJUSTMENT
376 ** Allows staff to administer the proximity adjustments
379 Custom best-hold selection sort order
380 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
381 The ranking algorithm that chooses the best hold to target a copy in
382 hand at a capture time used to be fairly simple. It had two modes, FIFO
383 and not-FIFO, and that was it.
385 This change allows full configuration of that algorithm. In other
386 words, when the system captures a copy and sets out to evaluate what
387 hold, if any, that copy might best fulfill, site staff of sufficient
388 permission level are now empowered to choose exactly which comparisons
389 the systems makes in what order. This gives said staff much greater
390 flexibility than they have today over holds policy.
392 For more information, see the included tech spec documents.
396 One new permission is added for this feature:
398 * ADMIN_HOLD_CAPTURE_SORT
399 ** Allows staff to adminster the custom best-hold selection sort order.
401 Generic CSV Notification Generator/Receiver
402 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
404 New Action/Trigger template and sample event definitions for creating a CSV
405 export file for various patron actions, primarily for the purpose of creating
406 patron notices via external notification mechanisms.
408 The reference implementation for this development is the TalkingTech iTiva
409 product, which consumes CSV files for generating phone/text notifications and
410 produces CSV results files for informing the ILS of notification statuses.
411 The template and send/receive scripts, however, should be generic enough to
412 create CSV for any type of 3rd-party notification product.
414 For more information, see the included tech spec documents.
416 Storing Z39.50 Server Credentials
417 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
419 In the Z39.50 configuration interface, staff now have the option to apply
420 z39.50 login credentials to each Z39.50 server at different levels of the
421 org unit hierarchy (similar to org unit settings). When credentials are set
422 for a Z39 server, searches against the z39 server will used the stored
423 credentials, unless other credentials are provided by the caller, in which
424 case the caller credentials are used.
426 For security purposes, passwords may not be retrieved or reported on by staff.
427 Staff can only apply new values for credentials or clear existing ones.
431 In order to support verification of URLs, Evergreen now has several new
432 capabilities, and extensions to some existing features.
434 A wizard-style interface that walks a staff member through the process of collecting records and URLs to verify, verifying and reviewing the URLs.
436 URL validation sessions are built as a whole to support immediate and
437 future review of any URLs. Each session carries a name, an owner, a set
438 of record search criteria, a set of tag and subfield combinations describing
439 the location of URLs to validate, a record container for tracking individual
440 records to verify, and a set of state and data tables for managing the
441 processing of individual URLs.
443 A set of middle-layer methods provide the business logic required to collect
444 records, extract, parse and test the validity of the URLs.
446 For more information, see the included tech spec documents.
450 One new permission is added for this feature:
457 Serial Control: Embed Alternate Interfaces
458 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
459 As another step toward a unified interface, the serial control subscription
460 editor now consists of an embedded version of the alternate control. This
461 reduces duplication of both code and documentation, and smooths the eventual
462 transition to a single interface.
464 In order to not lose any essential features, the following additions were made
465 to the new combination editor:
467 * note editors on subscriptions and distributions
468 * labeled dropdown for distribution summary options ("Add to record entry", "Use record entry only", etc.)
469 * legacy record entry linkage setup (Allows one to tie a distribution's information to a particular serial record entry (i.e. a MFHD record))
471 Serial Control: Set Special Statuses
472 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
473 The Serial Control interface prevents direct editing of serial item statuses
474 for data integrity reasons. As an alternative to direct control, the interface
475 now offers new menu options for setting items to 'claimed', 'not held', and
476 'not published'. Note that these statuses are still currently useful for
477 reporting and display purposes only.
482 Staff client search preferences
483 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
484 Staff can now set workstation-level search preferences through Admin ->
485 Workstation Administration -> Set Search Preferences.
487 * Default Search Library sets the library that is searched by default from
488 the advanced search page and the portal page.
489 * Preferred library is used to identify copies that should display first.
490 * Advanced search default pane allows staff to set the numeric or expert
491 searches as the default search tab.
493 The option to change the preferred search library from the search results page
494 is no longer available when logged into the staff client.
496 add "about:about" to developer menu in staff client
497 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
499 about:about gives access to various XULRunner diagnostic tools.
503 Get information about how the staff client is built.
505 Tweak XULRunner settings.
507 Get detailed information about the memory usage of the staff
516 One common need for people evaluating Evergreen, as well as for developers,
517 writers, and testers, is a set of sample data that can be easily loaded into
518 the Evergreen database and provide a consistent set of results for testing
519 and training purposes.
521 This release features sets of sample data consisting of:
523 * 100 bibliographic records retrievable via a "concerto" keyword search
524 * 100 French bibliographic records
525 * Associated call numbers, copies, parts, and conjoined items
526 * Patron accounts, including some recently expired patrons
527 * Circulation transactions, including some holds and some overdue items
529 To load the sample data into a freshly installed Evergreen database, you can
530 pass the following arguments to the `eg_db_config` script (either when you are
531 creating the initial database schema, or as a separate call after creating the
534 * `--load-all-sample`: Loads all sample data, including bibliographic records,
535 call numbers, copies, users, and transactions.
536 * `--load-concerto-sample`: Loads a subset of sample data that includes just
537 100 bibliographic records, and associated call numbers and copies.