Initial cut of 2.3 release notes.
[working/Evergreen.git] / docs / RELEASE_NOTES_2_3.txt
1 Release notes
2 =============
3 :toc:
4 :numbered:
5
6 Upgrade notes
7 -------------
8
9 New features
10 ------------
11
12 Acquisitions
13 ~~~~~~~~~~~~
14
15 ACQ Invoice Inline Lineitem Search and Add
16 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
17
18 The Invoice UI is how composed of two tabs, the main invoice tab and a new Search tab.  The search tab consists of a subset of the Acquisitions unified search interface.  The goal is to allow users to search for lineitems to invoice.  Search results may be added directly to the growing invoice.  A number of small usability features are included.
19
20 Features
21 ++++++++
22
23     * Option (default) to limit searches to invoiceable items.  
24         ** These are lineitems that are not cancelled, have at least one invoiceable copy, linked to a PO whose provider matches that of the current invoice, and are not already linked to the current invoice.
25     * Search defaults to last-run search (on workstation).
26     * New Lineitem Detail filter options
27     * Sort searches by lineitem number (default) and title.
28     * There is a new Expected Cost field which includes both the total invoiced cost plus the anticipated cost of lineitems as they are added.
29     * New Price per Copy field
30     * Lineitem count field
31     * Show / Hide Invoice details button.  Details are displayed by default, but hidden when the user enters the search tab.  From there it remains hidden until manually shown (or a new invoice is opened).
32     * A new "Save & Clear" button which saves the current invoice then clears the invoice display to create a new invoice.
33     * Provider, shipper, and receiver fields are auto-populated from the first-added invoice data (when not already set).
34     * Totals are now read-only, since they are derived from existing data (and are informational only).
35
36
37 EDI Invoices
38 ^^^^^^^^^^^^
39
40 The same setup that is required today for retrieving and reacting to EDI Order
41 Response messages (ORDRSP) will also react to Invoices (INVOIC).
42
43 This essentially means you must have a Provider (acq.provider) configured with
44 an EDI Account (acq.edi_account) containing login credentials for a vendor, you must have the edi_webrick service running (EDI translator), and you must have
45 the edi_pusher script run periodically by cron.
46
47 An open Evergreen invoice will be created for a each EDI Invoice message.
48 Evergreen invoice entries will be created for each lineitem detected in the
49 EDI message if that lineitem can be linked to a known Evergreen lineitem in
50 your system.  An Evergreen invoice item will be created for a whole-invoice
51 tax.
52
53 OPAC
54 ~~~~
55
56
57 TPAC: Simplified CSS Color Customization
58 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59 CSS colors are now defined as a pair of Template::Toolkit files,
60 `Open-ILS/src/templates/opac/css/styles.css.tt2` and
61 `Open-ILS/src/templates/opac/parts/css/colors.tt2`. Evergreen administrators
62 can customize the color scheme for a given skin by copying `colors.tt2` into a
63 template override directory and adjusting the colors as desired.
64
65 Change required to eg_vhost.conf
66 ++++++++++++++++++++++++++++++++
67 To enable Apache to pass the CSS file to the Template::Toolkit handler, you
68 must remove `.css` from the list of file extensions that should not be passed
69 to a handler in `eg_vhost.conf` as follows:
70
71 .From
72 ------------------------------------------------------------------------------
73 <LocationMatch ^/eg/.*(\.js|\.css|\.html|\.xhtml|\.xml|\.jpg|\.png|\.gif)$>
74     SetHandler None
75 </LocationMatch>
76 ------------------------------------------------------------------------------
77
78 .To
79 ------------------------------------------------------------------------------
80 <LocationMatch ^/eg/.*(\.js|\.html|\.xhtml|\.xml|\.jpg|\.png|\.gif)$>
81     SetHandler None
82 </LocationMatch>
83 ------------------------------------------------------------------------------
84
85 After making this change, restart Apache to make the change take effect.
86
87
88 Add to Permanent Bookbag
89 ^^^^^^^^^^^^^^^^^^^^^^^^
90
91 TPAC was modified to allow a logged-in user to add records from search
92 results and record summary screens to their permanent bookbags rather
93 than to a temporary bookbag that goes away when logged out.
94
95 Bookbag Selection Menu
96 ++++++++++++++++++++++
97
98 The search results and record summary screens were modified so that
99 the "Add to my list" will show a menu when moused over by a logged-in
100 user.  This menu will display the option to add to a temporary
101 bookbag, the user's default list (if any), up to ten of the user's
102 other bookbags, a "See all" option to allow the user to choose one of
103 the bags not on the menu, and to create a new list and add the record
104 to it.
105
106 Choosing the temporary list from the menu will add the record to the
107 temporary my list as TPAC does before the addition of this feature.
108
109 Choosing a named list will add the record to the chosen list.
110
111 Choosing "See all" or "Add to new list" will take the user to their My
112 Lists page.  (The only difference being that "See all" will actually
113 list all of the user's bookbags if they have more than the current
114 limit.)  The My Lists page will have a new button "Add to this list"
115 next to each of their existing lists.  In addition, if the user
116 creates a new list on this screen, the selected record will
117 automatically be added to this new list.
118
119 You can tell all of the above is working if you are redirected to your
120 search results or record summary after adding to a list.  If there was
121 a problem, you will get either an error page or will see your My Lists
122 page.
123
124 Designating a Default Bookbag/list
125 ++++++++++++++++++++++++++++++++++
126
127 The user's My List screen has had a 'Make Default List' button added
128 for each list.  Clicking the button will cause that list to be
129 registered as the user's default list.  This is the list that will be
130 added to when a user chooses the Default List option on the Add to my
131 list menu in search or record summary.
132
133 The current default list has a 'Remove Default List' button next to
134 it.  Clicking this button will unset the default status of the list
135 and return to a state of having no default list.
136
137 One handy way that users may want to use this feature is to create a
138 new list, and then designate it as the default.  This list could then
139 be used to add records from searches based on a current topic of
140 interest.  Changing the default list is so easy that users may want to
141 do so when changing search topics in order to keep their results
142 better organized.
143
144 A Note on CSS Styles
145 ++++++++++++++++++++
146
147 If a user has a bookbag with an overly long name, the end of it will
148 jut out past the right margin of the menu in FireFox and several other
149 browsers.  To change this behavior, you may want to edit the `.popmenu
150 li:hover li a` css entry in `web/css/skin/default/opac/style.css` by
151 adding an `overflow` property.  If you desire to have the longer names
152 clipped to the size ofthe menu then add `overlow: hidden`.  If you
153 prefer to have a scroll bar for oversized entries, then add `overflow:
154 auto`.
155
156
157 Warn When Adding to a Temporary Bookbag
158 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
159
160 TPAC has been modified so that a user will see a warning before adding
161 a record to a temporary bookbag.  This message serves to inform the
162 user that they are adding to a temporary list that will disappear when
163 their session ends.
164
165 A new org. unit setting has been added,
166 opac.patron.temporary_list_warn, that will enable this warning when
167 set.  Sites may choose not to display this warning.
168
169 The user may also set a preference in their search preferences to
170 disable this warning.  The setting only works when a user is logged
171 in, of course.
172
173
174 Cataloging
175 ~~~~~~~~~~
176
177 Z39.50 Source Attributes Management Interface
178 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
179
180 There is a new interface for managing Z39.50 attributes on a Z39.50
181 source.  The interface is linked from each source name in the Z39.50
182 Source administrative interface.
183
184 Cloning
185 +++++++
186
187 In addition to attribute creation, deletion, and editing, it's also 
188 possible to clone a set of attributes from one source into another.
189 When cloning, any attributes present in the cloned source that are
190 not present in the destination source are copied into the destination 
191 source.
192
193 Vandelay (MARC Import/Export) Copy Overlay
194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195
196 Vandelay Item Attributes (Cataloging -> MARC Import / 
197 Export -> Import Item Attribute Definitions) contains 
198 a new field called "Overlay Match ID".  The presence of data 
199 in this field extracted from an import-item copy indicates 
200 to the Vandelay import process that a copy overlay is requested 
201 instead of new copy creation.  The value for the field is the 
202 copy id for bib record queues and the ACQ lineitem_detail ID for 
203 Acquisitions Queues.  For either type of queue, however, overlay 
204 occurs against a real copy (asset.copy).  In the ACQ queue case, 
205 we use the lineitem_detail ID because this is the data ACQ 
206 providers and sub-systems will have access to.
207
208 When a match point ID value is a set and a matching copy is found, 
209 the values extracted from the inbound copy data are used to replace 
210 values on the existing found copy, including the call-number label.  
211 Any fields on the inbound copy that are empty are ignored.
212
213 One use case for this feature are shelf-ready items produced by a 
214 3rd-party (e.g. ACQ provider) and delivered to the library via MARC
215 file for upload.  The file might contain improved MARC bibliographic
216 data as well as real barcodes (i.e. not temporary ACQ generated 
217 barcodes) for the copies already purchased through the vendor.
218
219 Permission
220 ++++++++++
221
222 This adds a new permission called IMPORT_OVERLAY_COPY which is 
223 required to perform the copy overlay step.
224
225 Regardless of permission, it is not possible to overlay values on
226 a copy unless the imported bib record links (creates/overlays/merges)
227 to/with the owning bib record for the copy to be overlaid.  This is 
228 both for security and removal of a potent foot-gun.
229
230 Circulation
231 ~~~~~~~~~~~
232
233 Simplified Hold Pull List
234 ^^^^^^^^^^^^^^^^^^^^^^^^^
235
236 There is a new hold pull list interface based on the Flattener service that's
237 designed to perform faster than existing pull list interfaces, both in staff
238 client display and printing.
239
240 Sorting
241 +++++++
242
243 You can sort on any one column by clicking on it.  Click again to reverse
244 direction.  This is typical of similar interfaces.
245
246 Now you can also sort by multiple columns.  Right click the column headers of
247 the grid in the pull list interface to get a dialog that allows you to sort
248 by multiple columns, in any order.
249
250 Column Picking
251 ++++++++++++++
252
253 The same dialog that allows you to choose multiple sort columns (accessed by
254 right clicking any column header) also allows you to toggle the display of any
255 column available to the pull list on or off.
256
257 Persistence
258 +++++++++++
259
260 Once saved, your changes in this dialog persist for your user account.  Column
261 display, display order, and `sorting choices affect printing as well as
262 displayed output.
263
264 Administration
265 ~~~~~~~~~~~~~~
266
267 Search Filter Groups
268 ^^^^^^^^^^^^^^^^^^^^
269
270 Search filter groups support the collection of free-form search queries into
271 named groups of named filters which can be applied to searches.  The purpose 
272 is to allow systems to fine tune filters in the catalog.
273
274 Editing the groups and their entries is done in the staff client at
275 Admin -> Local Administration -> Search Filter Groups.
276
277 Example
278 +++++++
279
280 Consider a new filter called "reading_level".  It uses a combination of 
281 MARC audience and shelving location to differentiate items.  It might have
282 entries that look like this:
283
284 Children's Materials => audience(a,b,c) locations(1,2,3,4,5,6,7)
285
286 Young Adult => audience(j,d) locations(5,6,7,8,9,10)
287
288 Adult => audience(e,f,g, ) -locations(1,2,3,4,5,6,7,8,9)
289
290 Using the filter in a template
291 ++++++++++++++++++++++++++++++
292
293 [source, html]
294 ---------------------------------------------------
295 <span>[% ctx.filter_groups.reading_level.label %]<span>
296 <span>
297 [%
298     INCLUDE 'opac/parts/filter_group_selector.tt2'
299     filter_group='reading_level'
300     none_ok=1
301     none_label=l('All')
302 %]
303 <span>
304 ---------------------------------------------------
305
306 Staff Client
307 ~~~~~~~~~~~~
308
309 XULRunner / Firefox
310 ^^^^^^^^^^^^^^^^^^^
311 Support for later versions of XULRunner is included, which means that later
312 improvements to XULRunner can be taken advantage of. This also means that the
313 Firefox extension mode works in Firefox 3.6+, though some frequent tweaking
314 will be needed due to the rapid Firefox major release schedule.
315
316 The majority of the actual changes are backend changes, but there are some
317 significant things to note for local customizations.
318
319 Remote XUL
320 ++++++++++
321 Remote XUL no longer works in XULRunner/Firefox 4+, but to work around it a
322 custom extension now creates an oils:// wrapper. Within the staff client that
323 wrapper contains a "remote" host, from which server-side XUL can be loaded.
324
325 Custom XUL pages stored on the server will need to reference the new wrapper
326 to function.
327
328 As a note: The new wrapper is used for all OPAC access and only talks SSL.
329
330 enablePrivilege
331 +++++++++++++++
332 The enablePrivilege command that would allow code to access various protected
333 functionality is no longer available. Any code that depended upon it will need
334 to be adjusted to use the oils:// wrapper created for Remote XUL.
335
336 Cookies
337 +++++++
338 Unfortunately, the oils:// wrapper has one less than useful effect. Any
339 JavaScript loaded via it loses access to cookies. This is most notable when you
340 are dealing with authtoken cookies. This only applies to JavaScript, however,
341 and the server can still see the cookies when it gets requests.
342
343 As a workaround you can load the data stash and fetch authtokens via it instead.
344 This should always work when using the oils:// wrapper due to the elevated
345 permission set it gets (nearly, if not equal to, local XUL).
346
347 url_prefix
348 ++++++++++
349 Finally, as a useful feature, the url_prefix function is now slightly easier to
350 use. Instead of needing to reference urls.SOMETHING you can instead just put the
351 SOMETHING at the start of the url to prefix:
352
353 url_prefix('SOMETHING/stuff.html')
354
355 In this case SOMETHING can be terminated by the end of the string or up to the
356 first instance of a slash (/), question mark (?), or pipe (|). The pipe is a
357 special case and is removed during the replacement.
358
359 For example, if urls.REPLACE were set to 'oils://remote/replace':
360
361 url_prefix('REPLACE/stuff') becomes 'oils://remote/replace/stuff'
362 url_prefix('REPLACE?query') becomes 'oils://remote/replace?query'
363 url_prefix('RPLACE|ment') becomes 'oils://remote/replacement'
364
365 The pipe is intended for cases where the urls entry may or may not already
366 contain a query string, say for differences between OPACs where one requires
367 that something be passed into the query string, but the other uses a path
368 component instead.