update holds queue
authorNicole C. Engard <nengard@gmail.com>
Fri, 3 Aug 2012 19:45:44 +0000 (15:45 -0400)
committerNicole C. Engard <nengard@gmail.com>
Fri, 3 Aug 2012 19:45:44 +0000 (15:45 -0400)
en/manual.xml

index 5348bda..8db5462 100644 (file)
@@ -24044,10 +24044,8 @@ location: [STAFF, ISO]</programlisting>Will block items with an itype code of
       <section id="holdsqueue">
         <title>Holds Queue</title>
 
-        <para>This report will show you all of the holds at your library. To
-        generate this report, you must have the <link
-        linkend="buildholdscron">Build Holds Queue cron job</link>
-        running.</para>
+        <para>This report will show you all of the holds at your
+        library.</para>
 
         <screenshot>
           <screeninfo>Sample Holds Queue</screeninfo>
@@ -24058,6 +24056,49 @@ location: [STAFF, ISO]</programlisting>Will block items with an itype code of
             </imageobject>
           </mediaobject>
         </screenshot>
+
+        <para>To generate this report, you must have the <link
+        linkend="buildholdscron">Build Holds Queue cron job</link> running.
+        This cron job is a script that should be run periodically if your
+        library system allows borrowers to place on-shelf holds. This script
+        decides which library should be responsible for fulfilling a given
+        hold request.</para>
+
+        <para>It's behavior is controlled by the system preferences <link
+        linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link
+        linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
+
+        <para>If you do not want all of your libraries to participate in the
+        on-shelf holds fulfillment process, you should list the the libraries
+        that *do* participate in the process here by inputting all the
+        participating library's branchcodes, separated by commas ( e.g.
+        "MPL,CPL,SPL,BML" etc. ).</para>
+
+        <para>By default, the holds queue will be generated such that the
+        system will first attempt to hold fulfillment using items already at
+        the pickup library if possible. If there are no items available at the
+        pickup library to fill a hold, build_holds_queue.pl will then use the
+        list of libraries defined in StaticHoldsQueueWeight. If
+        RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
+        script will assign fulfillment requests in the order the branches are
+        placed in the StaticHoldsQueueWeight system preference.</para>
+
+        <para>For example, if your system has three libraries, of varying
+        sizes ( small, medium and large ) and you want the burden of holds
+        fulfillment to be on larger libraries before smaller libraries, you
+        would want StaticHoldsQueueWeight to look something like
+        "LRG,MED,SML".</para>
+
+        <para>If you want the burden of holds fulfillment to be spread out
+        equally throughout your library system, simply enable
+        RandomizeHoldsQueueWeight. When this system preference is enabled, the
+        order in which libraries will be requested to fulfill an on-shelf hold
+        will be randomized each time the list is regenerated.</para>
+
+        <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
+        time. Doing so will cause the build_holds_queue script to ignore
+        RandomizeHoldsQueueWeight, causing the script to request hold
+        fulfillment not randomly, but by alphabetical order.</para>
       </section>
 
       <section id="holdspull">