0462cc9b8c978e303bfbd2e65ce92721785ab6dc
[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 Record Attributes Reingest Recommended
10 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 After this update, it is recommended that you reingest your
12 bibliographic records to update the fixed field, record attribute
13 indexes.  This is mainly necessary to make sure that fiction books do
14 not also show up as non-fiction.
15
16 You can accomplish this by running the following query in your database:
17
18 [source,sql]
19 --------------------------------------------------------------------
20 select metabib.reingest_record_attributes(id)
21 from biblio.record_entry;
22 --------------------------------------------------------------------
23
24
25
26 New features
27 ------------
28
29
30
31 Acquisitions
32 ~~~~~~~~~~~~
33
34
35
36 Acquisitions speed improvements
37 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
38 Improvements to the rendering of the acquisitions fund selector will improve
39 the speed at which the purchase order, copy grid, PO/invoice charge creator,
40 and distribution formula editor load. These speed improvements will be most
41 noticeable for sites that use a lot of funds.
42
43
44
45
46
47
48 Differentiate Delayed vs Canceled Items
49 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
50
51 Background
52 ++++++++++
53 Canceled and delayed lineitems and copies in acquisitions are marked as
54 canceled in the database.  The determining factor of whether an item is
55 delayed or canceled is the keep_debits flag on the cancel reason.  
56
57 The changes below help to differentiate between these two closely related 
58 states by improving labels in the interface and providing separate counts
59 for delayed vs. canceled.
60
61 Changes
62 +++++++
63
64  * Show number canceled and number delayed in lineitem summary displays
65   ** Includes summary displays in invoices and copy grids
66  * Update stock cancel cause labels to include "Canceled:.." and 
67    "Delayed:..." prefixes.
68  * When a lineitem or copy is marked as canceled, show the cancel cause
69    label in the interface instead of the bare (and misleading and non-I18N 
70    friendly) string "cancelled".
71    ** Related, for non-canceled states, show a translatable string 
72      representing the name of the state instead of the bare state code.
73  * Add cancel cause labels to the print PO and lineitem worksheet templates.
74
75 Support Cancellation of Delayed Lineitems
76 +++++++++++++++++++++++++++++++++++++++++
77
78 When a lineitem is marked as delayed (canceled with keep_debits == true), 
79 allow staff to cancel the lineitem again in the ACQ PO/Picklist interface.
80 Once a lineitem is marked as truly canceled, it cannot be canceled again.
81
82
83
84
85 Administration
86 ~~~~~~~~~~~~~~
87
88
89
90 Switch to XLSX format for Excel report output
91 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
92 With previous versions of Evergreen, reports generated in the Excel output
93 were limited to a maximum of 64,000 rows.  This was a limitation due to the 
94 Excel format ".xls". Now, new report outputs for Excel will use format ".xlsx"
95 which allows for much larger report output rows.
96
97
98
99
100
101 Report Editing
102 ^^^^^^^^^^^^^^
103 Users may now view and edit existing reports.
104
105 With each report in the Reports folder view there are two new links,
106 one for viewing (read-only) and one for editing.  After changing a 
107 report, the user has the option to save the modified report
108 or create a new report with the new values, in effect cloning
109 the original report.
110
111 When saving a changed report, if a pending report run exists, the user
112 will be warned of this and asked if they would prefer to modify the
113 scheduled report or to instead save the changed values as a new 
114 report, leaving the original report intact.
115
116
117
118
119 Reports Documentation Links and Hints
120 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
121  * Report templates support a new External URL field, which may
122    contain a link to template-specific, local documentation.
123
124   ** When set, a link to the external documentation will be
125      displayed in a new column in the template list and within
126      the report editor.
127
128   ** URL's are set in the 'Documentation URL' entry.
129
130  * Template display fields and filters support a new Field Hint
131    value.  When set, hints are displayed in the report editor.
132
133   ** Values are set via the 'Change Field Hint' option along
134      the bottom of the template editor.
135
136
137
138
139
140
141 Secondary Permission Groups
142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
143
144 Secondary permission groups, available through the patron editor, allow admins
145 to add supplemental permission groups to staff accounts. The
146 *CREATE_USER_GROUP_LINK* and *REMOVE_USER_GROUP_LINK* permissions are required
147 to display and use this feature. 
148
149 <<secondaryperms, View Documentation>>.
150
151
152
153
154
155
156 Cataloging
157 ~~~~~~~~~~
158
159
160
161 TPAC Copy View/Edit Links
162 ^^^^^^^^^^^^^^^^^^^^^^^^^
163 Adds 'view' and 'edit' links next to each copy in the TPAC record
164 details copy grid when viewed from within the staff client.  The 'edit'
165 link only appears when the authenticated user has permission to edit the
166 specified copy.
167
168 Both links open new tabs.  When the 'edit' link used, the 'Unified
169 Volume/Item Creator/Editor' org unit setting is inspected to determine
170 which style of copy edit interface to display.
171
172
173
174
175 Display "Imported As" in Vandelay Queue
176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177 This simple new feature appears within the Cataloging *MARC Batch 
178 Import/Export* screens. When viewing the contents of a Vandelay queue, 
179 for example when inspecting a queue or right after bib imports, there is 
180 a new column displayed called _Imported As_. This new column displays the 
181 record ID, also known as the bib number, of the bib records currently 
182 listed in the queue. If the bib records listed in the queue have not been 
183 imported yet, this column is blank until the queued records are imported. 
184 After import the queued records will display the assigned record ID for 
185 the listed bib(s).
186
187
188
189
190 MARC Stream Importer
191 ^^^^^^^^^^^^^^^^^^^^
192
193 New command line options were added to marc_stream_importer.pl for
194 passing additional Vandelay import flags.  Prior to this change, only
195 auto-overlay-exact was supported.  
196
197 New options:
198
199   * --auto-overlay-exact
200     ** Overlay/merge on exact 901c matches
201   * --auto-overlay-1match
202     ** Overlay/merge when exactly one match is found
203   * --auto-overlay-best-match
204     ** Overlay/merge on best match
205   * --import-no-match
206     ** Import when no match is found
207
208 Like Vandelay, these options can be combined.
209
210
211
212
213 Monograph Part Merging
214 ^^^^^^^^^^^^^^^^^^^^^^
215
216 The monograph part list for a bibliographic record may, over time, diverge from the
217 proscribed format, resulting in multiple labels for what are essentially the same
218 item.  For instance, ``++Vol.{nbsp}1++'' may have variants like ``++V.1++'', ``++Vol{nbsp}1++'', or ``++{nbsp}Vol.{nbsp}1++'' (leading space).
219 This feature will allow catalog staff to collapse the variants into one value.
220
221 In the Monograph Parts display:
222
223 . Click the checkbox for all items you wish to merge including the one you wish to prevail when done.
224 . Click on the ``Merge Selected'' button. A pop-up window will list the selected items in
225 a monospaced font, with blanks represented by a middle-dot character for more visibility.
226 . Click on the item you wish to prevail.
227
228 The undesired part labels will be deleted, and any copies that previously used those labels will 
229 now use the prevailing label.
230
231
232
233
234 Circulation
235 ~~~~~~~~~~~
236
237
238
239 Change to Holds Shelf Expire Report
240 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241
242 When limiting to Clearable Holds in the Browse Holds Shelf interface, the
243 system will no longer display and clear holds expiring today. Instead, it will
244 look for holds that expired before today.
245
246
247
248
249 Support holds targeting and fullfillment of precats for ILL
250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
251 Adds support for holds targeting and fullfillment of copy-level holds on
252 pre-cat records. This feature makes integration with FulfILLment, NCIP and
253 other ILL mediators easier because pre-cat copies can sucessfully be used for
254 the ILL records.
255
256
257
258
259
260 Support for a Lost and Paid Status
261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
262 This feature supports a new, optional, _Lost and Paid_ status that can be used
263 by sites that want to distinguish between lost items with outstanding bills and
264 those that have been fully paid. A site may want to make this distinction to
265 set different OPAC visibility or holdability rules for these items.
266
267 If enabled, when a lost item is fully paid, the copy's status will automatially
268 change to _Lost and Paid_.
269
270 New setting available via the Library Settings Editor
271 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
272 - Use Lost and Paid copy status (circ.use_lost_paid_copy_status)
273
274
275
276
277 OPAC
278 ~~~~
279
280
281
282 Added Content by Record ID
283 ^^^^^^^^^^^^^^^^^^^^^^^^^^
284
285 The Template Toolkit OPAC will now load all Added Content by the Record ID, not
286 just jacket images. This will allow added content providers that support it to
287 load additional content by other identifiers.
288
289
290
291
292 Content Cafe Added Content Update
293 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
294 The OpenILS::WWW::AddedContent::ContentCafe provider has been updated to use the
295 newer Content Cafe 2 API in full. With this update the ability to load content
296 based on ISBN or UPC is now enabled.
297
298
299 "No Image" Images
300 +++++++++++++++++
301 With the updated code the option for displaying a "No Image" image or a 1x1
302 pixel image is no longer available. Instead the Apache-level "blank image" rules
303 will trigger when no image is available. The configuration option controlling
304 this behavior can thus be removed from opensrf.xml entirely.
305
306
307 Identifier Selection
308 ++++++++++++++++++++
309 By default the module will prefer ISBNs over UPCs, but will request information
310 for both. If you wish for UPCs to be preferred, or wish one of the two
311 identifier types to not be considered at all, you can change the
312 "identifier_order" option in opensrf.xml. When the option is present only the
313 identifier(s) listed will be sent.
314
315
316
317
318 More RDA 264 tag support
319 ^^^^^^^^^^^^^^^^^^^^^^^^
320
321 The OPAC now displays RDA bib tag 264 information for Producer, Distributor, 
322 Manufacturer, and Copyright within a full bib record’s summary. This is in 
323 addition to the RDA bib tag 264 publisher information, indicator 2 equal 
324 to 1, that was already being displayed in previous versions of Evergreen. 
325 The OPAC full bib view also now contains the Schema.org copyrightYear value.
326
327 Additionally, this information is now available in search results as well 
328 when viewing more details.
329
330
331
332
333 Sitemap generator
334 ^^^^^^^^^^^^^^^^^
335 A http://www.sitemaps.org[sitemap] directs search engines to the pages of
336 interest in a web site so that the search engines can intelligently crawl
337 your site. In the case of Evergreen, the primary pages of interest are the
338 bibliographic record detail pages.
339
340 The sitemap generator script creates sitemaps that adhere to the
341 http://sitemaps.org specification, including:
342
343 * limiting the number of URLs per sitemap file to no more than 50,000 URLs;
344 * providing the date that the bibliographic record was last edited, so
345   that once a search engine has crawled all of your sites' record detail pages,
346   it only has to reindex those pages that are new or have changed since the last
347   crawl;
348 * generating a sitemap index file that points to each of the sitemap files.
349
350 Running the sitemap generator
351 +++++++++++++++++++++++++++++
352 The `sitemap_generator` script must be invoked with the following argument:
353
354 * `--lib-hostname`: specifies the hostname for the catalog (for example,
355   `--lib-hostname https://catalog.example.com`); all URLs will be generated
356   appended to this hostname
357
358 Therefore, the following arguments are useful for generating multiple sitemaps
359 per Evergreen instance:
360
361 * `--lib-shortname`: limit the list of record URLs to those which have copies
362   owned by the designated library or any of its children;
363 * `--prefix`: provides a prefix for the sitemap index file names
364
365 Other options enable you to override the OpenSRF configuration file and the
366 database connection credentials, but the default settings are generally fine.
367
368 Note that on very large Evergreen instances, sitemaps can consume hundreds of
369 megabytes of disk space, so ensure that your Evergreen instance has enough room
370 before running the script.
371
372 Scheduling
373 ++++++++++
374 To enable search engines to maintain a fresh index of your bibliographic
375 records, you may want to include the script in your cron jobs on a nightly or
376 weekly basis.
377
378 Sitemap files are generated in the same directory from which the script is
379 invoked, so a cron entry will look something like:
380
381 ------------------------------------------------------------------------
382 12 2 * * * cd /openils/var/web && /openils/bin/sitemap_generator
383 ------------------------------------------------------------------------
384
385
386
387 Acknowledgments
388 ---------------
389 The Evergreen project would like to acknowledge the following
390 organizations who commissioned developments in this release of
391 Evergreen:
392
393  * **TODO**
394
395 We would also like to thank the following individuals who contributed
396 code and documentations patches to this release of Evergreen:
397
398  * **TODO**
399
400 We also thank the following organizations whose employees contributed
401 patches:
402
403  * **TODO**
404
405 We regret any omissions.  If a contributor has been inadvertantly
406 missed, please open a bug at http://bugs.launchpad.net/evergreen/
407 with a correction.
408