docs/RELEASE_NOTES_2_4.txt

   1 Evergreen 2.4 Alpha1 Release Notes
   2 ==================================
   3 :toc:
   4 :numbered:
   5
   6 Upgrade notes
   7 -------------
   8
   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:
  15
  16 * ADMIN_TOOLBAR_FOR_ORG
  17 * ADMIN_TOOLBAR_FOR_USER
  18 * ADMIN_TOOLBAR_FOR_WORKSTATION
  19
  20 New features
  21 ------------
  22
  23 Acquisitions
  24 ~~~~~~~~~~~~
  25
  26 Acquisitions MARC Upload Form Persistence
  27 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  28 Adds a two-layer persistence mechanism for the acquisitions MARC file upload
  29 interface.  A set of org unit settings now exist for managing default values
  30 for the interface.  Additionally, for each field where no org unit setting
  31 value is configured, the last-used value will be persisted locally and re-
  32 used with subsequent loads of the interface.
  33
  34 OPAC
  35 ~~~~
  36
  37 Display alternate graphic (880) fields
  38 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  39
  40 By default, Evergreen displays alternate graphic fields, if any, for
  41 contributors (1xx / 7xx), titles (245), edition statements (250), imprints
  42 (260), notes (5xx), subjects (6xx), and series (4xx / 8xx) in search results and record details
  43 per the Library of Congress MARC21 specifications:
  44
  45 * http://www.loc.gov/marc/bibliographic/bd880.html
  46 * http://www.loc.gov/marc/bibliographic/ecbdcntf.html
  47 * http://www.loc.gov/marc/bibliographic/ecbdmulti.html (Model A)
  48
  49 Default display
  50 +++++++++++++++
  51 In general, alternate graphic fields display below the corresponding
  52 primary field. One exception is the attribution summary on the record details
  53 page, in which the alternate graphic field contents display between the
  54 primary field content and the attribution statement. To support CSS
  55 customizations, HTML elements for the graphic fields have the class attribute
  56 value `graphic880`.
  57
  58 Search Changes
  59 ^^^^^^^^^^^^^^
  60 A number of changes have been made to search to allow more control and improve
  61 performance. These changes and their associated configurations are global to
  62 the entire system and can not be configured on a per-library basis.
  63
  64 Amongst other things the new search code fixes:
  65
  66 * Inability to use statuses and locations as part of a larger query
  67 * Invalid queries being generated from advanced searches
  68 * Some timeouts from backend code taking too long to preform a search
  69 * Some filters being one-use only
  70 * Negations not working properly where multiple indexes are involved
  71
  72 Improvements include:
  73
  74 * Exact matches on input should be more likely to float to the top of results
  75 * Non-English stemming can be used, alongside or instead of English stemming
  76 * Entered search terms can be found across multiple indexes
  77
  78 Default configuration is geared towards English but is easily changed. In a
  79 production environment changes will likely require re-indexing, however.
  80
  81 The upgrade script could be pre-tweaked to install desired configuration before
  82 it builds and/or re-builds many of the indexes.
  83
  84 TPAC Google Books preview
  85 ^^^^^^^^^^^^^^^^^^^^^^^^^
  86 Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2`
  87 configuration file will cause the TPAC to check to see, as part of the record
  88 details view, if Google Books has an online preview available. If it does,
  89 then a preview button will be displayed in the book cover image location.
  90 If the user then clicks the preview button, the preview will load below the
  91 title of the book in the record details page.
  92
  93 By default, this functionality is disabled to protect the privacy of users
  94 who might not want to share their browsing behaviour with Google.
  95
  96 TPAC Org Unit Hiding
  97 ^^^^^^^^^^^^^^^^^^^^
  98 Adds support for the opac.org_unit_hiding.depth org unit setting to
  99 TPAC, which makes out-of-scope org units disappear (except when
 100 explicitly requested).
 101
 102 Org unit hiding is based on the physical_loc (Physical Location) param /
 103 cookie, which is the closest analog to 'ol' (original location), from
 104 which it was based in the JSPAC.
 105
 106 UI Changes
 107 ++++++++++
 108
 109  * All search org unit selectors
 110  * Holds pickup lib selector
 111  * Copy summary in search results page
 112  * Copy list in search results page
 113  * Copy summary in record detail page (which controls the copy grid).
 114  * Hold summary in record detail page
 115
 116 Cataloging
 117 ~~~~~~~~~~
 118
 119 Vandelay Default Match Set
 120 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 121 A new org unit setting to specify a default Record Match Set when
 122 importing MARC records through the MARC Batch Import/Export interface. It does
 123 not affect the default match set selected in acquisitions. If this
 124 is set, it will not be possible to leave the Record Match Set field blank;
 125 it may be necessary to define a default match set that replicates the current
 126 default behavior.
 127
 128 A new "Vandelay" org unit settings group is also created.
 129
 130 Circulation
 131 ~~~~~~~~~~~
 132
 133 Clickable Patron Indicators
 134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 135 When retrieving a patron record, staff can now click on the indicators listed
 136 beneath the patron's name and launch the related tabs.
 137
 138 For example, clicking on (See Notes) will open the associated patron's notes.
 139
 140 "Warn patrons when their account is about to expire"
 141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 142 To give staff the ability to warn patrons when their account is about to
 143 expire, the staff client can display an alert message on the patron information
 144 window.  A new library setting, `Warn patrons when their account is about to
 145 expire` in the *Circulation* section of the *Library Settings Editor*,
 146 determines how many days in advance of a patron's account expiry date the alert
 147 should be displayed. By default, warnings about upcoming patron account expiry
 148 dates are not displayed.
 149
 150 Show Hold Patron Name in TPAC
 151 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 152 When looking up patron information for hold placement via the staff client in
 153 TPac the hold patron name is now shown next to the entered barcode. In the event
 154 that the barcode is not found a notice is displayed and the submit button is
 155 disabled until a valid barcode is entered or the staff member is switched to.
 156
 157 Administration
 158 ~~~~~~~~~~~~~~
 159
 160 Calculated Proximity Adjustments
 161 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 162 Allows customization to the way that Evergreen measures the distance between
 163 org units for the purposes of 1) determining what copy at what org unit is best
 164 suited for targeting a title-level hold, and 2) determining what hold is best
 165 suited for fulfillment by a copy-in-hand at capture (checkin) time.  The
 166 customization is based on a table 'actor.org_unit_proximity_adjustment', with
 167 certain matching criteria that the system compares to properties of the holds
 168 and copies in question.
 169
 170 Custom best-hold selection sort order
 171 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 172 The ranking algorithm that chooses the best hold to target a copy in
 173 hand at a capture time used to be fairly simple.  It had two modes, FIFO
 174 and not-FIFO, and that was it.
 175
 176 This change allows full configuration of that algorithm.  In other
 177 words, when the system captures a copy and sets out to evaluate what
 178 hold, if any, that copy might best fulfull, site staff of sufficient
 179 permission level are now empowered to choose exactly which comparisons
 180 the systems makes in what order.  This gives said staff much greater
 181 flexibililty than they have today over holds policy.
 182
 183 For more information, see the included tech spec documents.
 184
 185 Staff Client
 186 ~~~~~~~~~~~~
 187
 188 add "about:about" to developer menu in staff client
 189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 190
 191 about:about gives access to various XULRunner diagnostic tools.
 192 Useful ones include:
 193
 194 about:buildconfig::
 195     Get information about how the staff client is built.
 196 about:config::
 197     Tweak XULRunner settings.
 198 about:memory::
 199     Get detailed information about the memory usage of the staff
 200     client.
 201
 202 Miscellaneous
 203 -------------
 204
 205 Loading Sample Data
 206 ~~~~~~~~~~~~~~~~~~~
 207 One common need for people evaluating Evergreen, as well as for developers,
 208 writers, and testers, is a set of sample data that can be easily loaded into
 209 the Evergreen database and provide a consistent set of results for testing
 210 and training purposes.
 211
 212 This release features sets of sample data consisting of:
 213
 214 * 100 bibliographic records retrievable via a "concerto" keyword search
 215 * 100 French bibliographic records
 216 * Associated call numbers, copies, parts, and conjoined items
 217 * Patron accounts, including some recently expired patrons
 218 * Circulation transactions, including some holds and some overdue items
 219
 220 To load the sample data into a freshly installed Evergreen database, you can
 221 pass the following arguments to the `eg_db_config` script (either when you are
 222 creating the initial database schema, or as a separate call after creating the
 223 database schema):
 224
 225 * `--load-all-sample`: Loads all sample data, including bibliographic records,
 226    call numbers, copies, users, and transactions.
 227 * `--load-concerto-sample`: Loads a subset of sample data that includes just
 228   100 bibliographic records, and associated call numbers and copies.
 229