eaa9677cf5589cf731ab2ebc1912e13589e2d563
[working/Evergreen.git] / docs / RELEASE_NOTES_2_7.txt
1 Evergreen 2.7 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Upgrade notes
7 -------------
8
9 New Color in colors.tt2
10 ~~~~~~~~~~~~~~~~~~~~~~~
11 A new color called _mobile_header_text_ has been added to colors.tt2. Evergreen
12 sites will need to customize this color so that it fits with their catalog's
13 color scheme. The color is used to define new search links that will appear in
14  _My Account_ screens when viewed on screens smaller than 600px wide. It will
15  also be used on any future text that appears in the header area of the catalog.
16
17 Record Attributes Reingest Recommended
18 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19 After this update, it is recommended that you reingest your
20 bibliographic records to update the fixed field, record attribute
21 indexes.  This is mainly necessary to make sure that fiction books do
22 not also show up as non-fiction.
23
24 You can accomplish this by running the following query in your database:
25
26 [source,sql]
27 --------------------------------------------------------------------
28 select metabib.reingest_record_attributes(id)
29 from biblio.record_entry;
30 --------------------------------------------------------------------
31
32
33
34 New features
35 ------------
36
37
38
39 Acquisitions
40 ~~~~~~~~~~~~
41
42
43
44 Acquisitions speed improvements
45 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46 Improvements to the rendering of the acquisitions fund selector will improve
47 the speed at which the purchase order, copy grid, PO/invoice charge creator,
48 and distribution formula editor load. These speed improvements will be most
49 noticeable for sites that use many funds.
50
51
52
53
54
55
56 Differentiate Delayed vs. Canceled Items
57 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
58
59 Background
60 ++++++++++
61 Canceled and delayed lineitems and copies in acquisitions are marked as
62 canceled in the database.  The determining factor of whether an item is
63 delayed or canceled is the keep_debits flag on the cancel reason.  
64
65 The changes below help to differentiate between these two closely-related 
66 states by improving labels in the interface and providing separate counts
67 for delayed vs. canceled.
68
69 Changes
70 +++++++
71
72  * Show number canceled and number delayed in lineitem summary displays
73   ** Includes summary displays in invoices and copy grids
74  * Update stock cancel cause labels to include "Canceled:.." and 
75    "Delayed:..." prefixes.
76  * When a lineitem or copy is marked as canceled, show the cancel cause
77    label in the interface instead of the bare (and misleading and non-I18N 
78    friendly) string "cancelled".
79    ** Related, for non-canceled states, show a translatable string 
80      representing the name of the state instead of the bare state code.
81  * Add cancel cause labels to the print PO and lineitem worksheet templates.
82
83 Support Cancellation of Delayed Lineitems
84 +++++++++++++++++++++++++++++++++++++++++
85
86 When a lineitem is marked as delayed (canceled with keep_debits == true), 
87 allow staff to cancel the lineitem again in the ACQ PO/Selection List interface.
88 Once a lineitem is marked as truly canceled, it cannot be canceled again.
89
90
91
92
93 Administration
94 ~~~~~~~~~~~~~~
95
96
97
98 Switch to XLSX format for Excel report output
99 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
100 With previous versions of Evergreen, reports generated in the Excel output
101 were limited to a maximum of 64,000 rows.  This was a limitation due to the 
102 Excel format ".xls". Now, new report outputs for Excel will use format ".xlsx"
103 which allows for much larger report output rows.
104
105
106
107
108
109 Report Editing
110 ^^^^^^^^^^^^^^
111 Users may now view and edit existing reports.
112
113 With each report in the Reports folder view there are two new links,
114 one for viewing (read-only) and one for editing.  After changing a 
115 report, the user has the option to save the modified report
116 or create a new report with the new values, in effect cloning
117 the original report.
118
119 When saving a changed report that has a pending run, the user
120 will be warned of this and asked if they would prefer to modify the
121 scheduled report or to instead save the changed values as a new 
122 report, leaving the original report intact.
123
124
125
126
127 Reports Documentation Links and Hints
128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
129  * Report templates support a new External URL field, which may
130    contain a link to template-specific, local documentation.
131
132   ** When set, a link to the external documentation will be
133      displayed in a new column in the template list and within
134      the report editor.
135
136   ** URL's are set in the 'Documentation URL' entry.
137
138  * Template display fields and filters support a new Field Hint
139    value.  When set, hints are displayed in the report editor.
140
141   ** Values are set via the 'Change Field Hint' option along
142      the bottom of the template editor.
143
144
145
146
147
148
149 Secondary Permission Groups
150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
151
152 The patron registration/edit screen now has an interface for adding
153 secondary permission groups (profiles) to a user account.  This gives
154 library staff the ability to assign sets of permissions from multiple
155 permission groups to a single user.  For example, if you have a
156 cataloger who also does acquisitions, and you have separate permission
157 groups for Catalogers and Acquisitions, the new UI allows you to add
158 acquisitions as a secondary perm group on the cataloger's account, thus
159 granting all Acquisitions permissions to that user without changing the
160 user's primary profile group.
161
162 Library staff require the *CREATE_USER_GROUP_LINK* and
163 *REMOVE_USER_GROUP_LINK* permissions (which already exist in Evergreen) in order
164 to add or remove a user's secondary permission groups.
165
166
167
168
169
170
171 Cataloging
172 ~~~~~~~~~~
173
174
175
176 TPAC Copy View/Edit Links
177 ^^^^^^^^^^^^^^^^^^^^^^^^^
178 Adds 'view' and 'edit' links next to each copy in the TPAC record
179 details copy grid when viewed from within the staff client.  The 'edit'
180 link only appears when the authenticated user has permission to edit the
181 specified copy.
182
183 Both links open new tabs.  When the 'edit' link is used, the 'Unified
184 Volume/Item Creator/Editor' org unit setting is inspected to determine
185 which style of copy edit interface to display. When the 'view' link is used,
186 the copy details display in the Item Status screen.
187
188
189
190
191 Display "Imported As" in Vandelay Queue
192 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
193 This simple new feature appears within the Cataloging *MARC Batch 
194 Import/Export* screens. When viewing the contents of a Vandelay queue, 
195 for example when inspecting a queue or right after bib imports, there is 
196 a new column called _Imported As_. This new column displays the 
197 record ID, also known as the bib number, of the bib records currently 
198 listed in the queue. If the bib records listed in the queue have not been 
199 imported yet, this column is blank until the queued records are imported. 
200 After import the queued records will display the assigned record ID for 
201 the listed bib(s).
202
203
204
205
206 MARC Stream Importer
207 ^^^^^^^^^^^^^^^^^^^^
208
209 New command line options were added to marc_stream_importer.pl for
210 passing additional Vandelay import flags.  Prior to this change, only
211 auto-overlay-exact was supported.  
212
213 New options:
214
215   * --auto-overlay-exact
216     ** Overlay/merge on exact 901c matches
217   * --auto-overlay-1match
218     ** Overlay/merge when exactly one match is found
219   * --auto-overlay-best-match
220     ** Overlay/merge on best match
221   * --import-no-match
222     ** Import when no match is found
223
224 Like Vandelay, these options can be combined.
225
226
227
228
229 Monograph Part Merging
230 ^^^^^^^^^^^^^^^^^^^^^^
231
232 The monograph part list for a bibliographic record may, over time, diverge from
233 the proscribed format, resulting in multiple labels for what are essentially the
234 same item.  For instance, ++Vol.{nbsp}1++ may have variants
235 like ++V.1++, ++Vol{nbsp}1++, or ++{nbsp}Vol.{nbsp}1++ (leading
236 space).This feature will allow cataloging staff to collapse the variants into
237 one value.
238
239
240
241 Circulation
242 ~~~~~~~~~~~
243
244
245
246 Change to Holds Shelf Expire Report
247 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
248
249 When limiting to Clearable Holds in the Browse Holds Shelf interface, the
250 system will no longer display and clear holds expiring today. Instead, it will
251 look for holds that expired before today.
252
253
254
255
256 Support holds targeting and fulfillment of precats for ILL
257 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
258 Adds support for holds targeting and fulfillment of copy-level holds on
259 pre-cat records. This feature makes integration with FulfILLment, NCIP and
260 other ILL mediators easier because pre-cat copies can successfully be used for
261 the ILL records.
262
263
264
265
266
267 Support for a Lost and Paid Status
268 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
269 This feature supports a new, optional, _Lost and Paid_ status that can be used
270 by sites that want to distinguish between lost items with outstanding bills and
271 those that have been fully paid. A site may want to make this distinction to
272 set different OPAC visibility or holdability rules for these items.
273
274 If enabled, when a lost item is fully paid, the copy's status will automatically
275 change to _Lost and Paid_.
276
277 New setting available via the Library Settings Editor
278 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
279 - Use Lost and Paid copy status (circ.use_lost_paid_copy_status)
280
281
282 Client
283 ~~~~~~
284
285 Web client preview
286 ^^^^^^^^^^^^^^^^^^
287
288 The 2.7 release will contain a preview of web client circulation features.
289 Circulation is the first step in moving all staff functions from the existing
290 XULRunner-based client to a web application that will be based on AngularJS. 
291
292 Evergreen is moving away from the existing client because XULRunner no longer 
293 supports features critical to the Evergreen software, including remote XUL,
294 multi-part streaming, and XML JavaScript. The new web client is expected to
295 show some speed improvements, to provide comprehensive support for
296 internationalization/localization, to provide good support for assistive
297 technologies, to be easier to customize locally, and to be more mobile friendly.
298
299 The intent of the preview is to make it easier for end users at Evergreen sites
300 to try the new client, become familiar with its features, and to
301 discover/report bugs that are found. To implement the client preview...
302
303 OPAC
304 ~~~~
305
306
307
308 Added Content by Record ID
309 ^^^^^^^^^^^^^^^^^^^^^^^^^^
310
311 The Template Toolkit OPAC will now load all Added Content by the Record ID, not
312 just jacket images. This will allow added content providers that support it to
313 load additional content by other identifiers.
314
315
316
317
318 Content Cafe Added Content Update
319 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
320 The OpenILS::WWW::AddedContent::ContentCafe provider has been updated to use the
321 newer Content Cafe 2 API in full. With this update the ability to load content
322 based on ISBN or UPC is now enabled.
323
324
325 "No Image" Images
326 +++++++++++++++++
327 With the updated code the option for displaying a "No Image" image or a 1x1
328 pixel image is no longer available. Instead the Apache-level "blank image" rules
329 will trigger when no image is available. The configuration option controlling
330 this behavior can thus be removed from opensrf.xml entirely.
331
332
333 Identifier Selection
334 ++++++++++++++++++++
335 By default the module will prefer ISBNs over UPCs, but will request information
336 for both. If you wish for UPCs to be preferred, or wish one of the two
337 identifier types to not be considered at all, you can change the
338 "identifier_order" option in opensrf.xml. When the option is present only the
339 identifier(s) listed will be sent.
340
341
342
343
344 More RDA 264 tag support
345 ^^^^^^^^^^^^^^^^^^^^^^^^
346
347 The OPAC now displays RDA bib tag 264 information for Producer, Distributor, 
348 Manufacturer, and Copyright within a full bib record’s summary. This is in 
349 addition to the RDA bib tag 264 publisher information, indicator 2 equal 
350 to 1, that was already being displayed in previous versions of Evergreen. 
351 The OPAC full bib view also now contains the Schema.org copyrightYear value.
352
353 Additionally, this information is now available in search results as well 
354 when viewing more details.
355
356
357
358
359 Sitemap generator
360 ^^^^^^^^^^^^^^^^^
361 A http://www.sitemaps.org[sitemap] directs search engines to the pages of
362 interest in a web site so that the search engines can intelligently crawl
363 your site. In the case of Evergreen, the primary pages of interest are the
364 bibliographic record detail pages.
365
366 The sitemap generator script creates sitemaps that adhere to the
367 http://sitemaps.org specification, including:
368
369 * limiting the number of URLs per sitemap file to no more than 50,000 URLs;
370 * providing the date that the bibliographic record was last edited, so
371   that once a search engine has crawled all of your sites' record detail pages,
372   it only has to reindex those pages that are new or have changed since the last
373   crawl;
374 * generating a sitemap index file that points to each of the sitemap files.
375
376
377
378 Acknowledgments
379 ---------------
380 The Evergreen project would like to acknowledge the following
381 organizations who commissioned developments in this release of
382 Evergreen:
383
384  * Bibliomation
385  * British Columbia Libraries Cooperative
386  * Central/Western Massachusetts Automated Resource Sharing
387  * Georgia Public Library Service
388  * Howe Library, Hanover, NH
389  * Massachusetts Library Network Cooperative
390  * NC Cardinal
391  * North of Boston Library Exchange
392  * Pennsylvania Integrated Library System
393  * Pioneer Library System
394  * South Carolina Library Evergreen Network Delivery System
395
396 We would also like to thank the following individuals who contributed
397 code and documentations patches to this release of Evergreen:
398
399  * Thomas Berezansky
400  * Jason Boyer
401  * Steven Chan
402  * Galen Charlton
403  * Jeff Davis
404  * Bill Erickson
405  * Jason Etheridge
406  * James Fournie
407  * Jeff Godin
408  * Blake Henderson
409  * Pasi Kallinen
410  * Victoria Lewis
411  * Kathy Lussier
412  * Terran McCanna
413  * Michele Morgan
414  * Suzanne Paterno
415  * Dan Pearl
416  * Jennifer Pringle
417  * Erica Rohlfs
418  * Mike Rylander
419  * Dan Scott
420  * Srey Seng
421  * Chris Sharp
422  * Ben Shum
423  * Robert Soulliere
424  * Remington Steed
425  * Jason Stephenson
426  * Josh Stompro
427  * Kyle Tomita
428  * Elliot Voris
429  * Dan Wells
430  * Liam Whalen
431  * Yamil Suarez
432
433 We also thank the following organizations whose employees contributed
434 patches:
435
436  * Berklee College of Music
437  * Bibliomation
438  * British Columbia Libraries Cooperative
439  * Calvin College
440  * Catalyst IT Services
441  * Central/Western Massachusetts Automated Resource Sharing
442  * Equinox Software, Inc.
443  * Georgia Public Library Service
444  * Indiana State Library
445  * Lake Agassiz Regional Library
446  * Laurentian University
447  * Massachusetts Library Network Cooperative
448  * Merrimack Valley Library Consortium
449  * MOBIUS
450  * Mohawk College
451  * North of Boston Library Exchange
452  * Pohjois-Karjalan Tietotekniikkakeskus Oy
453  * St. Louis Christian College
454  * Traverse Area District Library
455
456 We regret any omissions.  If a contributor has been inadvertently
457 missed, please open a bug at http://bugs.launchpad.net/evergreen/
458 with a correction.
459