7 Z39.50 Server Definitions
8 ~~~~~~~~~~~~~~~~~~~~~~~
9 Z39.50 server target definitions have been removed from the sample
10 `opensrf.xml.example` file. To migrate existing settings from your
11 `opensrf.xml` configuration file to the database, peform the
14 1. First, set up your custom Z39.50 sources in the database. For
15 each entry in `z3950/services`, map the following XML paths to the
16 corresponding `config.z3950_source` table column as follows:
18 ** `z3950/services/<entry>` = name
19 ** `//<entry>/name` = label
20 ** `//<entry>/host` = host
21 ** `//<entry>/port` = port
22 ** `//<entry>/db` = db
23 ** `//<entry>/record_format` = record_format
24 ** `//<entry>/transmission_format` = transmission_format
26 2. Then, for each attribute defined in the `<attrs>` element for
27 a given service, map the following XML paths to the corresponding
28 `config.z3950_attr` table column as follows:
30 ** `z3950/services/<entry>` = source
31 ** `//<entry>/attrs/<attr>` = name
32 ** `//<entry>/attrs/<attr>/code` = code
33 ** `//<entry>/attrs/<attr>/format` = format
35 3. After adding the new Z39.50 sources and corresponding attributes,
36 you will need to log out of the staff client and log back into the
37 staff client to retrieve the new entry values. If a given Z39.50
38 server does not work for a given attribute, pay attention to the
39 `truncation` column for the attribute.
50 Evergreen enables you to create an organizational tree that describes the systems, branches, or other units that comprise your organization. By default, the org unit tree that appears to patrons in the OPAC is identical to the one that appears to users of the staff client. Using this feature, you can condense or re-order the organizational tree into a simpler structure for patrons using the OPAC while maintaining the complex organizational tree that is available to users of the staff client.
52 As a further enhancement, you can hide a parental org unit yet still make its child org units visible in the OPAC. In previous versions of Evergreen, child org units inherited the visibility setting of their parents. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
55 Fine Accrual on Closed Dates
56 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
57 By default, fines accrue only on dates that the library is open. This feature enables you to charge patrons fines on dates the library is closed. Fines accrue during scheduled closings as well as during normal weekly closed dates. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
60 Target Copies for Holds at Closed Libraries
61 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62 By default, when a patron places a hold on a title, the hold targeter will search for copies to fill the hold only at circulating libraries that are open. Copies at closed libraries are not targeted to fill holds. When turned on, this feature enables Evergreen to target copies that have closed circulating libraries to fill holds. Two new org unit settings control this feature. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
68 Auto Suggest in Catalog Search
69 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
70 The auto suggest feature suggests the completion of search terms as the user enters his query. By default, the user will see ten suggestions although this number is configurable at the database level. Scroll through suggestions with your mouse, or use the arrow keys to scroll through the suggestions. Select a suggestion to view records that are linked to this suggestion.
72 This feature is not turned on by default. You must turn it on in the Admin module. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
77 This feature allows staff to create and name sets of copy locations to use as
78 a search filter in the catalog. OPAC-visible groups will display within the
79 library selector in the template toolkit OPAC. When a user selects a group
80 and performs a search, the set of results will be limited to records that have
81 copies in one of the copy locations within the group. Groups can live at any
82 level of the library hierarchy and may include copy locations from any parent
83 org unit or child org unit.
85 For advanced users, this change includes a new Query Parser filter called
90 The My Lists feature replaces the bookbag feature that was available in versions proior to 2.2. This feature enables you to create temporary and permanent lists; create and edit notes for items in lists; place holds on items in lists; and share lists via RSS feeds and CSV files. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
94 The SMS Text Messaging feature enables users to receive hold notices via text message. Users can opt-in to this hold notification as their default setting for all holds, or they can receive specific hold notifications via text message. Users can also send call numbers and copy locations via text message. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
96 New Patron Preferences
97 ^^^^^^^^^^^^^^^^^^^^^^^
98 Users will now have the ability to designate the following preferences in the template toolkit catalog:
100 * A preferred search location. Unlike the default search library in jspac, this setting will also control which copies display first
101 in search results and record detail screens.
102 * A preferred pickup location.
103 * The ability to keep a history of checked out items.
104 * The ability to keep a history of holds.
106 Credit Card Payment via Public Catalog
107 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
108 Patrons can now use credit cards to pay fines and bills in 'My Account' of the template toolkit OPAC.
110 Record Detail Print and E-mail Actions
111 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
112 Implements Print and Email actions (as links below add-to-list) in the tpac record detail page.
114 Identify Previously-Checked-Out Items in Search Results
115 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
116 When a user is logged into the tpac and performs a search, this feature indicates in the results set when any of the result items were ever checked
117 out by the logged-in user. Items will only be tagged when the related org setting is enabled and the user has opted in to circ history tracking.
121 Patron Statistical Category Enhancements
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123 The following enahncements have been added to patron statistical categories:
125 * categories can be marked as 'required' (must be filled out when a patron is registered)
126 * categories can be marked to allow or disallow user-created entries
127 * an entry for a given category and org unit can be marked as the default entry. It will be automatically selected in the new patron registration screen.
129 User Settings Available from Patron Editor
130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
131 Staff can now access and update user settings, like notification prefererences and default pickup library, in the patron editor.
133 Mark Patron E-mail or Phone as Invalid
134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 Staff can mark a patron's e-mail or phone as invalid in the patron editor. The system will clear the email
136 (or phone) field from actor.usr, and [both optionally, per OU setting] 1)create a corresponding standing penalty against the user, for staff to
137 notice next time they bring up said patron in the staff client, and 2)create a patron note. Related penalties (but not notes) will be cleared
138 whenever that patron's email address or phone number is updated again.
140 Address Alert in Patron Registration
141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
142 Support for comparing user addresses to alert addresses. When an address is found, the address in question is styled (the header row
143 turns red) and the configured alert message is shown along the top-right, where other warnings appear.
147 Telephony Improvements
148 ^^^^^^^^^^^^^^^^^^^^^^
149 Enhancements to notifications by telephony, including:
151 * A feature that allows an Evergreen system to roll over failed notifcations into new ones with a different notification method.
152 * Holiday awareness. There's a script (set_pbx_holidays) that can be run by cron on an Evergreen system to periodically update the PBX's table of holidays based on a given org unit's closed date ranges.
153 * Smart retry. In certain situations, if you put too many callfiles into Asterisk's spool at once, Asterisk will try to make too many
154 calls at once, and all such calls just fail. That's what the allocator is meant to prevent. Smart retry is about moving calls that
155 have been tried once, and will be retried again later due to resulting in a busy signal or other problem, out of the spool to make room for
156 other calls that could be made in the meantime.
158 Circulation Limit Groups & Limit Sets
159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
160 The new Circulation Limit Groups (server admin) can be thought of as 'Tags' the system places on circulations so
161 that it can find them later. The Limit Sets (local admin) define rules for limiting the number of active circulations a patron
162 may have based on Circulation Modifiers and Limit Groups. These new features support the following options:
164 * Setting circ limits for circulations that have no circ modifiers. This is useful for systems with circ rules based on something other than circ modifiers (e.g. MARC type)
165 or for grouping items that may have different circ modifiers so that, for example, you can count every video, regardles off circ modifiers.
166 * The ability to set limits for a single library's items, regardless of the checkout library.
168 New Checkin Modifiers
169 ^^^^^^^^^^^^^^^^^^^^^
170 The following modifiers have been added to the check-in interface:
172 * Clear Shelf-Expired Holds. When checking in something on the hold shelf run a 'Clear Shelf Process' for the specific copy id at that library to auto-clear any Shelf-Expired holds.
173 * Retarget Local Holds. When checking in 'in process' items that are owned by the library, attempt to find a local hold to retarget. This is intended to help with proper targeting of newly-cataloged items.
174 * Retarget All Statuses. Similar to 'Retarget Local Holds', this modifier will attempt to find a local hold to retarget, regardless of the status of the item being checked in. This modifier must be used in conjunction with the
175 'Retarget Local Holds' modifier.
176 * Capture Local Holds as Transits. With this checkin modifier, any local holds will be given an 'in transit' status instead of 'holds shelf'. The intent is to stop the system from sending holds notifications before the item is ready to be placed on the holds shelf. Possible use cases include Automated Materials Handling(AMH) checkins
177 in which items may be sitting in a bin for a while before landing on the holds shelf and checkins done on closed days.
181 This enhancement adds a new 'checkin_alert' column to copy locations. If true (defaults to false),
182 then a routing alert is generated at reshelving time for the location. This is intended for special locations,
183 such as 'Display', that may require special handling, or that temporarily contain items that are not normally in that location.
185 Age Hold Protection Based on a Copy's Active Date
186 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
187 * Adds a 'Sets copy active' column to the 'Copy Statuses' interface to identify statuses that indicate a copy is active and ready for checkout. The first time a copy is set to one of these statuses, the system adds an 'active date' for the copy, which can be used for reporting.
188 * Provides a new library setting for age hold protection to be based on the copy's active date instead of its create date.
190 Option to Place Holds on Age Protected Items
191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
192 Allow choice of placing hold despite age protection. This alters the backend to watch when so much as one copy failed
193 only due to age protection. In jspac, an alternate confirm message is shown. In tpac, the failure message is changed and
194 override is always allowed for the hold in question.
196 Force and Cataloging Recall Holds
197 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
198 Creates two new types of copy-level holds to cut in front of all other holds and ignore hold rules. For cataloging recall holds, the copy's status changes to 'cataloging' when it reaches its destination.
200 Archiving Stat Cats and Circ-Time Copy Locations
201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 Circ-time copy locations are now archived with circulations (aged or active). Using the Statistical Categories Editor, staff can also
203 designate stat cats (patron and copy) to archive with circulations.
205 Browse Holds Shelf Interface Displays Canceled Holds
206 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
207 Holds that are canceled after they are placed on the holds shelf will continue to display in this interface and will also display in the 'shelf-expired holds' view.
212 Vandelay Integration into Acquisitions
213 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
214 The Acquisitions Load MARC Order Record interface enables you to add MARC records to selection lists and purchase orders and upload the records into the catalog. The Vandelay interface enables you to create specific match points between incoming MARC records and exisiting catalog records. Combining these two features enables you to track on order MARC records through the Acquisitions interface and to utilize the record matching mechanisms available in Vandelay when importing acquisitions records. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
217 Receive Items from an Invoice
218 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
219 This feature enables users to receive items from an invoice. Staff can receive individual copies, or they can receive items in batch. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
221 Lineitem and Copy Actions Accessible from More Interfaces
222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
223 Users can now access lineitem actions (e.g. receive, unreceive, update barcodes, new invoice) from the acquisitions lineitem search results and selection list interfaces. Also available on these interfaces is a link to copy details
224 where users can take receive actions (receive, unreceive, cancel) on individual copies.
226 Improved Displays for Provider and Fund Admin Pages
227 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
228 This enhancement provides improved support for viewing the provider and fund admin pages. It also allows staff to use filters to find
234 Authority Control Sets
235 ^^^^^^^^^^^^^^^^^^^^^^
236 The tags and subfields that display in authority records in Evergreen are proscribed by control sets. The Library of Congress control set is the default control set in all versions of Evergreen. However, in Evergreen release 2.2, you can create customized control sets for authority records, and you can define thesauri and authority fields for these control sets.
238 Patrons and staff will be able to browse authorities in the OPAC. The following fields are browsable by default: author, series, subject, title, and topic. You will be able to add custom browse axes in addition to these default fields. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
241 Batch Importing MARC Records
242 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
243 The MARC Batch Import interface features improved matching of records and managing of your import queue. In version 2.2, you can specify match points between incoming and existing records to better detect matching records and prevent record duplication. You can also create quality controls to ensure that incoming matching records are superior in quality to existing catalog records.
245 You also have new options for managing your queue. You can apply filters to your queue, and you can generate a list of import errors. You can also print your queue, email your queue, or export your queue as a CSV file. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
248 Hide Fields in Copy Editor
249 ^^^^^^^^^^^^^^^^^^^^^^^^^^
250 Customize the Copy Editor for your staff by hiding fields in the Copy Editor that are not relevant to your staff. You can set these fields by org unit(s). Select the top level org unit that will use these settings, and the descendant org units will also recieve these settings. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
253 Prevent Bibliographic Records from Having Attached Copies
254 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
255 To enable libraries to designate specific sets of records as only for use
256 as electronic resources, it is possible to configure a bibliographic source
257 such that physical copies or MFHD records may not be attached to records
258 from that source. The `config.bib_source` table now includes a new Boolean
259 column, `can_have_copies`, that controls this behavior. If `can_have_copies`
260 for a given bibliographic source is `TRUE`, then the staff client will prevent
261 a cataloger from adding volumes or MFHD records to records belonging to that
262 source. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
265 Overlay Existing Catalog Record via Z39.50 Import
266 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
267 This feature enables you to replace a catalog record with a record obtained through a Z39.50 search. No new permissions or administrative settings are needed to use this feature. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
270 Restrict Z39.50 Sources by Permission Group
271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
272 This new feature enables you to use a permission to restrict users' access to Z39.50 servers. You can apply a permission to the Z39.50 servers to restrict access to that server, and then assign that permission to users or groups so that they can access the restricted servers. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
275 Switch Copy Location Name and Library Short Name in Copy Editor
276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
277 By default, the copy editor shows the library shortname ('BR1' or 'CONS')
278 followed by the copy location name ('Stacks', 'Reference'). A new workstation
279 setting, under *Admin -> Workstation Administration -> Copy Editor: Copy
280 Location Name First*, enables staff to change the display so that the copy
281 location name is displayed first, followed by the library shortname. This
282 may be particularly useful for libraries that have defined one set of copy
283 locations at the consortial level and want to enable quick keyboard navigation
284 to copy locations by typing just the first letters of the copy location. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
289 The User Activity Types feature enables you to specify the user activity that you want to record in the database. You can use this feature for reporting purposes. This function will also display a last activity date in a user's account. Currently, this feature only tracks user authentication. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
294 To support integration of Evergreen with organizational authentication systems,
295 and to reduce the proliferation of user names and passwords, Evergreen offers
296 a new service called `open-ils.auth_proxy`. If you enable the service,
297 `open-ils.auth_proxy` supports different authentication mechanisms
298 that implement the `authenticate` method. You can define a chain of these
299 authentication mechanisms to be tried in order within the `<authenticators>`
300 element of the `opensrf.xml` configuration file, with the option of falling
301 back to the `native` mode that uses Evergreen's internal method of password
304 This service only provides authentication; there is no support for automatic
305 provisioning of accounts. To authenticate against any authentication system,
306 the user account must first be defined within the Evergreen system, and
307 authentication will be based on the user name as it exists in Evergreen.
309 A sample authentication mechanism for LDAP is provided in
310 `Open-ILS::Application::AuthProxy::LDAP_AUTH`, and corresponding sample
311 attributes can be found in `opensrf.xml.example`.
315 This enhancement adds user and workstation IDs to the auditor tables. It also
316 adds/changes auditor functions to allow for setting, getting, and clearing auditor information,
317 as well as adding a couple of utility functions for updating auditors after changes to their origin columns.
322 New Views for Reporting Sources
323 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
324 To support the creation of collection development reports, the following
325 reporting sources have been added:
327 * 'Last Circulation or Creation Date' is a source that offers the copy ID,
328 the last circulation date or creation date, and the last circulation date
329 * 'Hold/Copy Ratio per Bib and Pickup Library' is a source that calculates
330 the number of holds per copy per bibliographic record, with granularity
334 Staff Client Navigation
335 ~~~~~~~~~~~~~~~~~~~~~~~
339 By default, two toolbars are available in the staff client: circulation and cataloging. This feature enables you to customize toolbars in the staff client. You can add buttons that will enable quick access to a variety of features. You can create toolbars for specific org unit(s), workstation(s), or login(s). Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
342 Double Clicking in the Staff Client
343 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
344 You can search for a patron's record, and double click on a result to access that record. You can double click on an item in the Holdings Maintenance screen to access copy information. The item is linked to the Volume/Copy Creator, if you turned it on in the staff client's org unit settings. If you did not turn on the Volume/Copy Creator, then the item links to the Item Attributes. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
347 Recent Staff Searches
348 ^^^^^^^^^^^^^^^^^^^^^
349 This feature enables you to view your recent searches as you perform them in the staff client. By default, staff can view then recent searches although the number is configurable. This feature is only available through the staff client; it is not available to patrons in the OPAC. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
352 Return to Search Results from MARC Record
353 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
354 This feature enables you to return to your title search results directly from any view of the MARC record, including the OPAC View, MARC Record, MARC Edit, and Holdings Maintenance. You can use this feature to page through records in the MARC Record View or Edit interfaces. You do not have to return to the OPAC View to access title results. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
359 This feature enables you to sort by multiple display columns so that you can find easily the information that you need on a screen. You can sort display columns on any screen that is built on a grid, such as the Check In screen or the On Shelf Pull List.
361 You can also sort the columns on the following Administration screens: Circulation Policies, Hold Policies, Circulation Limit Sets, Barcode Completion, Acquisitions User Request List, and Vandelay Import Errors.
363 You can sort items in an ascending or descending order, and you can prioritize the order in which columns will sort. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
367 This feature enables you to add a new tab to the Evergreen staff client by clicking the + sign adjacent to the tab that you currently have opened. As in previous versions, you can also add new tabs by clicking File -> New Tab, or use the hotkey, Ctrl+T. Documentation for this feature is available in the Book of Evergreen at http://docs.evergreen-ils.org/2.2/
369 Close All Tabs Shortcut
370 ^^^^^^^^^^^^^^^^^^^^^^^
371 Supports using CTRL+Click on the close tab 'X' to close all tabs.
373 Independent Column Configurations and Receipt Templates for Different Hold List Interfaces
374 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
375 Previously, all hold list interfaces shared the same column picker settings and receipt templates. This enhancement creates
376 independependent settings for the following interfaces:
378 * Actions for this Record -> View Holds
379 * Patron Display -> Holds
380 * Circulation -> Browse Hold Shelf
381 * Circulation -> Pull List for Hold Requests
385 The addition of a non-sortable line number column which displays the ordinal position of each row in the list. The first row in such a list will always have a value of 1 in the ordinal column, no matter how the list is sorted.
386 There's no special handling for paged interfaces; the first row on any given page still gets an ordinal value of 1.
390 Supports auto-login in the staff client by adding three new command line parameters: -ILSuser - Username to log in with -ILSpassword - Password to use -ILShost - hostname to use
394 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
395 Unported License. To view a copy of this license, visit
396 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
397 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
projects / working / Evergreen.git / blob