Documentation: Add triggered events and holds management docs from ESI.
authorSally Fortin <sfortin@esilibrary.com>
Thu, 16 Aug 2012 14:27:50 +0000 (10:27 -0400)
committerRobert Soulliere <robert.soulliere@mohawkcollege.ca>
Thu, 16 Aug 2012 14:27:50 +0000 (10:27 -0400)
Content and images from http://www.esilibrary.com/esi/availableDocs.php.
Also fixed some formatting issues for previous committed documentation.

Signed-off-by: Robert Soulliere <robert.soulliere@mohawkcollege.ca>
docs/admin/lsa-receipt_template_editor.txt
docs/admin/lsa-standing_penalties.txt
docs/admin/lsa-work_log.txt
docs/circulation/holds_management.txt [new file with mode: 0644]
docs/circulation/triggered_events.txt [new file with mode: 0644]
docs/media/Display_Hold_Types_on_Pull_Lists1.jpg [new file with mode: 0644]
docs/media/Triggered_Events_and_Notices1.jpg [new file with mode: 0644]
docs/media/Triggered_Events_and_Notices2.jpg [new file with mode: 0644]
docs/media/Triggered_Events_and_Notices3.jpg [new file with mode: 0644]
docs/root.txt

index d78d1d6..996a466 100644 (file)
@@ -1,8 +1,8 @@
 Receipt Template Editor
-=======================
+-----------------------
 
 Print Holds Slip with Landscape Layout
---------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This feature enables you to use Mozilla-specific CSS to print holds with a
 landscape layout. To use the landscape layout:
index 9819a9d..8160ebb 100644 (file)
@@ -1,5 +1,5 @@
 Standing Penalties
-==================
+------------------
 
 In versions of Evergreen prior to 2.3, the following penalty types were
 available by default.  When applied to user accounts, these penalties prevented
index 66c9731..22963f8 100644 (file)
@@ -1,8 +1,8 @@
 Work Log
-======== 
+-------- 
 
 Expanding the Work Log
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 In versions of Evergreen prior to 2.3, the work log recorded check ins,
 checkouts, patron registration, patron editing, and renewals.  In version 2.3,
diff --git a/docs/circulation/holds_management.txt b/docs/circulation/holds_management.txt
new file mode 100644 (file)
index 0000000..9e8c4d6
--- /dev/null
@@ -0,0 +1,28 @@
+Holds Management
+----------------
+
+Display Hold Types on Pull Lists
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This feature ensures that the hold type can be displayed on all hold interfaces.    
+
+You will find the following changes to the hold type indicator:
+
+. The hold type indicator will display by default on all XUL-based hold
+interfaces. XUL-based hold interfaces are those that number the items on the
+interface.  This can be overridden by saving column configurations that remove
+the column, *Type*.  
+. The hold type indicator will display by default on the HTML-based pull list.
+To access, click *Circulation* -> *Pull List for Hold Requests* -> *Print Full
+Pull List (Alternate Strategy)*.
+. The hold type indicator can be added to the Simplified Pull List.  To access,
+click Circulation* -> *Pull List for Hold Requests* -> *Simplified Pull List
+Interface*.
+
+To add the hold type indicator to the simplified pull list, click *Simplified
+Pull List Interface*, and right click on any of the column headers.  The Column
+Picker appears in a pop up window.  Click the box adjacent to *Hold Type*, and
+Click *Save*. The *Simplified Pull List Interface* will now include the hold
+type each time that you log into the staff client.
+
+image::media/Display_Hold_Types_on_Pull_Lists1.jpg[Display_Hold_Types_on_Pull_Lists1]
diff --git a/docs/circulation/triggered_events.txt b/docs/circulation/triggered_events.txt
new file mode 100644 (file)
index 0000000..0578169
--- /dev/null
@@ -0,0 +1,72 @@
+Triggered Events and Notices
+----------------------------
+
+Improvements to the Triggered Events interface enables you to easily filter,
+sort, and print triggered events from the patron's account or an item's details.
+This feature is especially useful when tracking notice completion from a
+patron's account.
+
+Access and View
+~~~~~~~~~~~~~~~
+
+You can access *Triggered Events* from two Evergreen interfaces: a patron's
+account or an item's details.  
+
+To access this interface in the patron's account, open the patron's record and
+click *Other* -> *Triggered Events*.
+
+To access this interface from the item's details, enter the item barcode into
+the *Item Status* screen, and click *Actions for Selected Items* -> *Triggered
+Events*.
+
+Information about the patron, the item, and the triggered event appear in the
+center of the screen.  Add or delete columns to the display by right clicking on
+any column. The *Column Picker* appears in a pop up box and enables you to
+select the columns that you want to display.
+
+image::media/Triggered_Events_and_Notices1.jpg[Triggered_Events_and_Notices1]
+
+Filter
+~~~~~~
+
+The triggered events that display are controlled by the filters on the right
+side of the screen.  By default, Evergreen displays completed circulation
+events.  Notice that the default filters display *Event State is Complete* and
+*Core Type is Circ*.  
+
+To view completed hold-related events, such as hold capture or hold notice
+completion, choose *Event State is Complete* and *Core Type is Hold* from the
+drop down menu.
+
+You can also use the *Event State* filter to view circs and holds that are
+*pending* or have an *error*.
+
+Add and delete filters to customize the list of triggered events that displays.
+To add another filter, click *Add Row*.  To delete a filter, click the red _X_
+adjacent to a row.
+
+image::media/Triggered_Events_and_Notices2.jpg[Triggered_Events_and_Notices2]
+
+Sort
+~~~~
+
+You can sort your results by clicking the column name.
+
+image::media/Triggered_Events_and_Notices3.jpg[Triggered_Events_and_Notices3]
+
+
+Print
+~~~~~
+
+You can select the events that you want to print, or you can print all events.
+To print selected events, check the boxes adjacent to the events that you want
+to print, and click *Print Selected Events*.  To print all events, simply click
+*Print All Events*.
+
+Reset
+~~~~~
+
+If the triggered event does not complete or the notice is not sent and the
+trigger needs to be run again, then select the event, and click *Reset Selected
+Events*.
+
diff --git a/docs/media/Display_Hold_Types_on_Pull_Lists1.jpg b/docs/media/Display_Hold_Types_on_Pull_Lists1.jpg
new file mode 100644 (file)
index 0000000..26d7952
Binary files /dev/null and b/docs/media/Display_Hold_Types_on_Pull_Lists1.jpg differ
diff --git a/docs/media/Triggered_Events_and_Notices1.jpg b/docs/media/Triggered_Events_and_Notices1.jpg
new file mode 100644 (file)
index 0000000..07392f6
Binary files /dev/null and b/docs/media/Triggered_Events_and_Notices1.jpg differ
diff --git a/docs/media/Triggered_Events_and_Notices2.jpg b/docs/media/Triggered_Events_and_Notices2.jpg
new file mode 100644 (file)
index 0000000..8ff0d82
Binary files /dev/null and b/docs/media/Triggered_Events_and_Notices2.jpg differ
diff --git a/docs/media/Triggered_Events_and_Notices3.jpg b/docs/media/Triggered_Events_and_Notices3.jpg
new file mode 100644 (file)
index 0000000..69d9ab0
Binary files /dev/null and b/docs/media/Triggered_Events_and_Notices3.jpg differ
index f5838ed..11d08f1 100644 (file)
@@ -250,10 +250,14 @@ system.
 
 include::circulation/circulating_items.txt[]
 
+include::circulation/holds_management.txt[]
+
 include::circulation/booking.txt[]
 
 include::circulation/circulation_patron_records.txt[]
 
+include::circulation/triggered_events.txt[]
+
 Reports
 =======