New documentation for 2.5
authorAngela Kilsdonk <akilsdonk@esilibrary.com>
Tue, 10 Dec 2013 19:30:28 +0000 (14:30 -0500)
committerAngela Kilsdonk <akilsdonk@esilibrary.com>
Tue, 10 Dec 2013 19:30:28 +0000 (14:30 -0500)
Documentation for:
-Z39.50 Search Enhancements
-Catalog Browse
-Alternative Hold Pick-up Location
-Marking Items Long Overdue
-Lost and Long Overdue Bill Colors
-Vandelay Item Load

Signed-off-by: Angela Kilsdonk <akilsdonk@esilibrary.com>
16 files changed:
docs/cataloging/batch_importing_MARC.txt
docs/cataloging/z39.50_search_enhancements.txt [new file with mode: 0644]
docs/circulation/circulating_items.txt
docs/circulation/circulation_patron_records.txt
docs/circulation/holds.txt
docs/media/Billed Transaction Color.JPG [new file with mode: 0644]
docs/media/Locate_Z39.50_Matches1.jpg [new file with mode: 0644]
docs/media/Locate_Z39.50_Matches2.jpg [new file with mode: 0644]
docs/media/Locate_Z39.50_Matches3.jpg [new file with mode: 0644]
docs/media/Locate_Z39.50_Matches4.jpg [new file with mode: 0644]
docs/media/custom_hold_pickup_location1.JPG [new file with mode: 0644]
docs/media/custom_hold_pickup_location2.JPG [new file with mode: 0644]
docs/media/long_overdue1.JPG [new file with mode: 0644]
docs/media/long_overdue2.JPG [new file with mode: 0644]
docs/opac/catalog_browse.txt [new file with mode: 0644]
docs/root.txt

index d143b65..2661de5 100644 (file)
@@ -285,3 +285,25 @@ image::media/Batch_Importing_MARC_Records12.jpg[Batch_Importing_MARC_Records12]
 
 image::media/Batch_Importing_MARC_Records14.jpg[Batch_Importing_MARC_Records14] 
 
+
+Default Values for Item Import 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Evergreen now supports additional functionality for importing items through *Cataloging* -> *MARC Batch Import/Export*.  When items are imported via a *Holdings Import Profile* in *Cataloging* -> *MARC Batch Import/Export*, Evergreen will create an item-level record for each copy.  If an item barcode, call number, copy location, or circulation modifier is not set in the embedded holdings, Evergreen will apply a default value based on the configured Library Settings.  A default prefix can be applied to the auto-generated call numbers and item barcodes.
+
+The following *Library Settings* can be configured to apply these default values to imported items:
+
+* *Vandelay: Generate Default Barcodes* —Auto-generate default item barcodes when no item barcode is present
+
+* *Vandelay: Default Barcode Prefix* —Apply this prefix to any auto-generated item barcodes
+
+* *Vandelay: Generate Default Call Numbers* —Auto-generate default item call numbers when no item call number is present
+
+* *Vandelay: Default Call Number Prefix* —Apply this prefix to any auto-generated item call numbers
+
+* *Vandelay: Default Copy Location* —Default copy location value for imported items
+
+* *Vandelay: Default Circulation Modifier* —Default circulation modifier value for imported items
+
+
+
diff --git a/docs/cataloging/z39.50_search_enhancements.txt b/docs/cataloging/z39.50_search_enhancements.txt
new file mode 100644 (file)
index 0000000..a36632c
--- /dev/null
@@ -0,0 +1,102 @@
+Z39.50 Search Enhancements
+--------------------------
+
+*Abstract*
+
+In Evergreen version 2.5, you will be able to search multiple Z39.50 sources simultaneously from record buckets.  Using this feature, you can match records from Z39.50 sources to catalog records in your bucket and import the Z39.50 records via Vandelay.  
+
+
+*Administration*
+
+The following administrative interfaces will enable you to configure Z39.50 search parameters.
+
+
+
+*Z39.50 Index Field Maps*
+
+Click *Admin* -> *Server Administration* -> *Z39.50 Index Field Maps* to map bib record indexes (metabib fields and record attributes) in your catalog records to Z39.50 search attributes.  Metabib fields are typically free form fields found in the body of a catalog record while record attributes typically have only one value and are often found in the leader.
+
+You can map a metabib field or a record attribute to a Z39.50 attribute or a Z39.50 attribute type.  To map a specific field in your catalog record to a specific field in a chosen Z39.50 source, you should map to a Z39.50 attribute.  For example, if you want the Personal Author in your catalog record to map to the Author field when searching the Library of Congress, then you should do the following:
+
+. Click *New* or double-click to edit an existing map.
+
+. Select the *Metabib Field* from the drop down menu.
+
+. Select the appropriate source and field from the *Z39.50 Attribute* drop down menu.
+
+. Click *Save*.
+
+
+Alternatively, if you want the Personal Author in your catalog record to map to the generic author field of any Z39.50 source, then you should do the following:
+
+. Click *New* or double-click to edit an existing map.
+
+. Select the *Metabib Field* from the drop down menu.
+
+. Select the appropriate heading from the *Z39.50 Attribute Type* drop down menu.
+
+. Click *Save*.
+
+
+
+*Z39.50 servers*
+
+Click *Admin* -> *Server Admin* -> *Z39.50 Servers* to input your Z39.50 server.  Click the hyperlinked name of any server to view the Z39.50 search attribute types and settings.  These settings describe how the search values (from a metabib field or record attribute) are translated into Z39.50 searches.
+
+
+
+
+*Apply Quality Sets to Z30.50 Sources*
+
+From this interface, you can rank the quality of incoming search results according to the match set that you have established and their Z39.50 point of origin.  By applying a quality score, you tell Evergreen to merge the highest quality records into the catalog.
+
+. Click *Cataloging* -> *MARC Batch Import/Export*.
+
+. Click *Record Match Sets*.  Match Sets specify the MARC attributes, tags, and subfields that you want Evergreen to use to identify matches between catalog and incoming records.
+
+. Rank the quality of the records from Z39.50 sources by adding quality metrics for the match set.  Click *MARC Tag and Subfield*, and enter the 901z tag and subfield, specify the Z39.50 source, and enter a quality metric.  Source quality increases as the numeric quality increases.  
+
+image::media/Locate_Z39.50_Matches4.jpg[Locate_Z39.50_Matches4]
+
+
+
+*Org Unit Settings*
+
+Org Unit settings can be set for your local branch, your system, or your consortium.  To access these settings, click  *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Maximum Parallel Z39.50 Batch Searches*.
+
+Two new settings control the Z39.50 search enhancements.
+
+. Maximum Parallel Z39.50 Batch Searches - This setting enables you to set the maximum number of Z39.50 searches that can be in-flight at any given time when performing batch Z39.50 searches.  The default value is five (5), which means that Evergreen will perform 5 searches at a given time regardless of the number of sources selected.  The searches will be divided between the sources selected. Thus, if you maintain this default and perform a search using two Z39.50 sources, Evergreen will conduct five searches, shared between the two sources.
+
+. Maximum Z39.50 Batch Search Results - This setting enables you to set the maximum number of search results to retrieve and queue for each record + Z39 source during batch Z39.50 searches. The default value is five (5).
+
+
+
+*Matching Records in Buckets with Records from Z39.50 Sources*
+
+. Add records to a bucket.
+
+. Click *Bucket Actions* -> *Locate Z39.50 Matches*.  A pop up window will appear.
+
+. Select a *Z39.50 Server(s)*.
+
+. Select a *Z39.50 Search Index(es)*.  Note that selecting multiple checkboxes will AND the search indexes.
+
+. Select a Vandelay queue from the drop down menu to which you will add your results, or create a queue by typing its name in the empty field.
+
+. Select a *Match Set*.  The Match Set is configured in Vandelay and, in this instance, will only be used to compare the Z39.50 results with the records in your bucket.
+
+. Click *Perform Search*.
+
+image::media/Locate_Z39.50_Matches1.jpg[Locate_Z39.50_Matches1]
+
+. Status information will appear, including the number of records in the bucket that were searched, the matches that were found, and the progress of the search.  When the search is complete, click *Open Queue*.
+
+image::media/Locate_Z39.50_Matches2.jpg[Locate_Z39.50_Matches2]
+
+. The Vandelay Queue will display.  Matching records are identified in the *Matches* column.  From this interface, import records according to your normal procedure.  It is suggested that to merge the incoming records with the catalog records, you should choose an option to import the records.  Next, select either merge option from the drop down menu, click *Merge on Best Match*, and then click *Import*.
+
+image::media/Locate_Z39.50_Matches3.jpg[Locate_Z39.50_Matches3]
+
+. The records from the Z39.50 search will merge with the catalog records. NOTE: A new column has been added to this interface to identify the Z39.50 source.  When records are imported to the Vandelay queue via a record bucket, Evergreen tags the Z39.50 source and enters the data into the $901z.
+
index c41b1ac..9446fbb 100644 (file)
@@ -325,3 +325,70 @@ image::media/copy_edit_alert.png[]
 image::media/copy_alert_message.png[]
 
 5) Click *Modify Copies*, then confirm the action.
+
+
+Mark an Item Long Overdue
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Marking an item Long Overdue*
+
+Once an item has been overdue for a configurable amount of time, Evergreen will mark the item long overdue in the borrowing patron’s account.  This will be done automatically through a Notification/Action Trigger.   When the item is marked long overdue, several actions will take place:
+
+. The item will go into the status of “Long Overdue” 
+
+. The item will be moved to the “Lost, Claimed Returned, Long Overdue, Has Unpaid Billings” section of the Items Out screen in the patron’s account
+
+. The accrual of overdue fines will be stopped
+
+Optionally the patron can be billed for the item price, a long overdue processing fee, and any overdue fines can be voided from the account.  Patrons can also be sent a notification that the item was marked long overdue.
+image::media/long_overdue1.JPG[Patron Account-Long Overdue]
+
+
+*Checking in a Long Overdue item*
+
+If an item that has been marked long overdue is checked in, an alert will appear on the screen informing the staff member that the item was long overdue.  Once checked in, the item will go into the status of “In process”.  Optionally, the item price and long overdue processing fee can be voided and overdue fines can be reinstated on the patron’s account.  If the item is checked in at a library other than its home library, a library setting controls whether the item can immediately fill a hold or circulate, or if it needs to be sent to its home library for processing.
+image::media/long_overdue2.JPG[Long Overdue Checkin]
+*Notification/Action Triggers*
+
+Evergreen has two sample Notification/Action Triggers that are related to marking items long overdue.  The sample triggers are configured for 6 months.  These triggers can be configured for any amount of time according to library policy and will need to be activated for use.
+
+* Sample Triggers
+
+** 6 Month Auto Mark Long-Overdue—will mark an item long overdue after the configured period of time
+
+** 6 Month Long Overdue Notice—will send patron notification that an item has been marked long overdue on their account
+
+*Library Settings* 
+
+The following Library Settings enable you to set preferences related to long overdue items:
+
+* *Circulation: Long-Overdue Check-In Interval Uses Last Activity Date* —Use the long-overdue last-activity date instead of the due_date to determine whether the item has been checked out too long to perform long-overdue check-in processing. If set, the system will first check the last payment time, followed by the last billing time, followed by the due date. See also circ.max_accept_return_of_longoverdue 
+
+* *Circulation: Long-Overdue Items Usable on Checkin* —Long-overdue items are usable on checkin instead of going "home" first
+
+* *Circulation: Long-Overdue Max Return Interval* —Long-overdue check-in processing (voiding fees, re-instating overdues, etc.) will not take place for items that have been overdue for (or have last activity older than) this amount of time 
+
+* *Circulation: Restore Overdues on Long-Overdue Item Return*
+
+* *Circulation: Void Long-Overdue item Billing When Returned*
+
+* *Circulation: Void Processing Fee on Long-Overdue Item Return*
+
+* *Finances: Leave transaction open when long overdue balance equals zero* —Leave transaction open when long-overdue balance equals zero. This leaves the lost copy on the patron record when it is paid
+
+* *Finances: Long-Overdue Materials Processing Fee*
+
+* *Finances: Void Overdue Fines When Items are Marked Long-Overdue*
+
+*Permissions to use this Feature*
+
+The following permissions are related to this feature:
+
+* COPY_STATUS_LONGOVERDUE.override
+
+** Allows the user to check-in long-overdue items thus removing the long-overdue status on the item
+
+
index 62374cc..b298eb1 100644 (file)
@@ -634,3 +634,18 @@ after the deletion.
 
 
 
+Lost and Long Overdue Bill Colors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This stylization enhancement distinguishes Lost and Long Overdue circulations that appear within the billed transactions of a patron’s account from other items that are still checked out.  
+
+Within the patron’s list of billed transactions, Lost or Long Overdue items, which have not yet been returned, display differently from other items that are still checked out. The color distinctions are applied to the entire row of the billed transaction (previous to version 2.5, only the title of the billed transaction was highlighted). These color enhancements are accompanied by helpful indicators that define the meaning of the colors for staff.  
+
+By default, Lost circulations will appear in dark red. The default indicator reads, “Dark Red Items are Lost.”  
+
+When the 6 Month Overdue Mark Long-Overdue trigger event definition is enabled, Long Overdue circulations will appear in orange, by default. The default indicator reads, “Orange Items are Long Overdue.”  
+image::media/Billed Transaction Color.jpeg[Billed Transaction Color]
+Both the color distinctions and indicators are customizable. To customize, a change to circ.css (for the color) and lang.dtd (for the indicator) are required.   
+
index 62711b3..4217a01 100644 (file)
@@ -383,6 +383,45 @@ Hold shelf expire time is inserted when a hold achieves on-hold-shelf status. It
 The clear-hold-shelf function cancels shelf-expired holds only. It does not include holds canceled by patron. Staff needs to trace these items manually according to the hold slip date.
 ===========
 
+
+Alternate Hold Pick up Location
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Abstract*
+
+This feature enables libraries to configure an alternate hold pick up location.  The alternate pick up location will appear in the staff client to inform library staff that a patron has a hold waiting at that location.  In the stock Evergreen code, the default alternate location is called "Behind Desk".  This label can be changed to accommodate a library's specific hold pick up location.  For example, if a library has a drive thru window for hold pick up, the alternate location can be changed to display as "Drive Thru".  
+
+*Configuration*
+
+The alternate pick up location is disabled in Evergreen by default.  It can be enabled by setting *Holds: Behind Desk Pickup Supported* to 'True' in the Library Settings Editor.  Server side changes to configuration files are required to enable this feature and edit the alternate pick up location label.  The following files and labels need to be changed:
+
+* Open-ILS/src/templates/opac/myopac/prefs_settings.tt2
+<td><label for='[% setting %]'>[% l('Pickup holds from the drive-thru when possible?') 
+%]</label></td>
+
+*  Open-ILS/web/opac/locale/en-US/lang.dtd
+<!ENTITY staff.patron_display.holds_available_behind_desk.label 'Drive-Thru:'>
+
+* Open-ILS/xul/staff_client/server/locale/en-US/circ.properties
+staff.circ.utils.hold.behind_desk=Drive-Thru
+
+* Open-ILS/xul/staff_client/server/locale/en-US/patron.properties
+staff.patron.summary.hold_counts_behind_desk=Available / Total (Drive-Thru)
+
+Libraries can also choose to give patrons the ability to opt-in to pick up holds at the alternate location through their OPAC account.  To add this option, set the *OPAC/Patron Visible* field in the User Setting Type *Hold is behind Circ Desk* to 'True'.  The User Setting Types can be found under *Admin -> Server Administration -> User Setting Types*.
+
+*Display*
+
+When enabled, the alternate pick up location will appear in several places in the staff client.  The alternate pick up location and the number of items that are ready for pick up at that location will be displayed in the Patron Account Summary and under the Holds button in the patron account.  Staff will also see the general number of holds available and holds placed by the patron.
+
+image::media/custom_hold_pickup_location1.JPG[Custom Hold Pickup Location]
+
+
+If configured, patrons will see the option to opt-in to the alternate location in the Account Preferences section of their OPAC Account.
+
+image::media/custom_hold_pickup_location2.JPG[OPAC Account]
+
+
 Display Hold Types on Pull Lists
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/docs/media/Billed Transaction Color.JPG b/docs/media/Billed Transaction Color.JPG
new file mode 100644 (file)
index 0000000..2e5bf36
Binary files /dev/null and b/docs/media/Billed Transaction Color.JPG differ
diff --git a/docs/media/Locate_Z39.50_Matches1.jpg b/docs/media/Locate_Z39.50_Matches1.jpg
new file mode 100644 (file)
index 0000000..55f9cb0
Binary files /dev/null and b/docs/media/Locate_Z39.50_Matches1.jpg differ
diff --git a/docs/media/Locate_Z39.50_Matches2.jpg b/docs/media/Locate_Z39.50_Matches2.jpg
new file mode 100644 (file)
index 0000000..707a43d
Binary files /dev/null and b/docs/media/Locate_Z39.50_Matches2.jpg differ
diff --git a/docs/media/Locate_Z39.50_Matches3.jpg b/docs/media/Locate_Z39.50_Matches3.jpg
new file mode 100644 (file)
index 0000000..f9a6435
Binary files /dev/null and b/docs/media/Locate_Z39.50_Matches3.jpg differ
diff --git a/docs/media/Locate_Z39.50_Matches4.jpg b/docs/media/Locate_Z39.50_Matches4.jpg
new file mode 100644 (file)
index 0000000..6bce86e
Binary files /dev/null and b/docs/media/Locate_Z39.50_Matches4.jpg differ
diff --git a/docs/media/custom_hold_pickup_location1.JPG b/docs/media/custom_hold_pickup_location1.JPG
new file mode 100644 (file)
index 0000000..bd41bea
Binary files /dev/null and b/docs/media/custom_hold_pickup_location1.JPG differ
diff --git a/docs/media/custom_hold_pickup_location2.JPG b/docs/media/custom_hold_pickup_location2.JPG
new file mode 100644 (file)
index 0000000..605dd89
Binary files /dev/null and b/docs/media/custom_hold_pickup_location2.JPG differ
diff --git a/docs/media/long_overdue1.JPG b/docs/media/long_overdue1.JPG
new file mode 100644 (file)
index 0000000..21249cf
Binary files /dev/null and b/docs/media/long_overdue1.JPG differ
diff --git a/docs/media/long_overdue2.JPG b/docs/media/long_overdue2.JPG
new file mode 100644 (file)
index 0000000..8669af8
Binary files /dev/null and b/docs/media/long_overdue2.JPG differ
diff --git a/docs/opac/catalog_browse.txt b/docs/opac/catalog_browse.txt
new file mode 100644 (file)
index 0000000..72522cb
--- /dev/null
@@ -0,0 +1,31 @@
+Catalog Browse
+--------------
+
+*Abstract*
+
+Catalog Browse enables you to browse bibliographic headings available in your catalog.  You can click the hyperlinked bibliographic headings to retrieve catalog records that contain these headings. Also, if a given bibliographic heading is linked to an authority record, and if that authority is linked to another one via the first authority's See and See Also tags, the additional variants of (e.g.) an author's name will appear in your search results. 
+
+
+*Use Catalog Browse*
+
+. To access this feature, navigate to the catalog search page, and click the link, *Browse the Catalog*.  By default, you can browse by title, author, subject, or series.  System administrators can revise this list by editing the file at the location 'opac/parts/qtype_selector.tt2', and they can even make use of custom indices based on defintions in the database's 'config.metabib_field' table.
+
+
+. Enter a term or part of a term to browse.  Evergreen will retrieve a list of bibliographic headings that match your query.  Click the *Back* and *Forward* buttons to page through you results.  To limit your browse results to a specific branch or copy location group, select the appropriate unit from the drop down menu, and click *Go*.   
+
+. Select a link from the search results.  Each linked heading displays the number of bibliographic records associated with the heading. Appropriate information from linked authority records, if any, appears below the main entry heading.     
+
+. To return to your list of results, click the browser's back button or *Browse the Catalog*.  Evergreen will return you to your previous position in your list of results.
+
+
+
+*Administration*
+
+A new global flag warns users when they are entering a browse term that begins with an article.  Systems administrators can create a regular expression to configure articles matched with specific indices that would prompt a warning for the user. By default, this setting is not enabled.
+
+. To enable this feature, click *Admin* -> *Server Administration* -> *Global Flags*.  
+
+. Double click *Map of search classes to regular expressions to warn user about leading articles.*
+
+. Make changes, and click *Save*.
+
index 3e4f559..10d4572 100644 (file)
@@ -265,6 +265,8 @@ include::cataloging/batch_importing_MARC.txt[]
 
 include::cataloging/overlay_record_3950_import.txt[]
 
+include::cataloging/z39.50_search_enhancements.txt[]
+
 include::cataloging/monograph_parts.txt[]
 
 include::cataloging/conjoined_items.txt[]
@@ -362,6 +364,8 @@ include::opac/my_lists.txt[]
 
 include::opac/kids_opac.txt[]
 
+include::opac/catalog_browse.txt[]
+
 include::opac/advanced_features.txt[]
 
 // Push titles down one level.