docs: updates to Best Hold Sort Selection Order
[Evergreen.git] / docs / modules / admin / pages / Best_Hold_Selection_Sort_Order.adoc
1 [#best_hold_selection_sort_order]
2 = Best-Hold Selection Sort Order =
3 :toc:
4
5 Best-Hold Selection Sort Order allows libraries to configure customized rules for Evergreen to use to select the best hold to fill at opportunistic capture.  When an item is captured for a hold upon check-in, Evergreen evaluates the holds in the system that the item could fill.  Evergreen uses a set of rules, or a Best-Hold Selection Sort Order, to determine the best hold to fill with the item.  In previous version of Evergreen, there were two sets of rules for Evergreen to use to determine the best hold to fulfill: Traditional and FIFO (First In, First Out).  Traditional uses Org Unit Proximity to identify the nearest hold to fill.  FIFO follows a strict order of first-in, first-out rules.  This feature allows new, custom Best-Hold Selection Sort Orders to be created.  Existing Best-Hold Selection Sort Orders can also be modified.
6
7
8 == Preconfigured Best-Hold Orders ==
9 Evergreen comes with seven preconfigured Best-Hold Selection Sort Orders to choose from:
10
11 * Traditional
12 * Traditional with Holds-go-home
13 * Traditional with Holds-always-go-home
14 * Traditional with Holds-chase-home-lib-patrons
15 * FIFO
16 * FIFO with Holds-go-home
17 * FIFO with Holds-always-go-home
18
19 The Holds-go-home and Holds-always-go-home options allow libraries to determine how long they want to allow items to transit outside of the item’s home library, before it must return to its home library to fulfill any holds that are to be picked up there.  Libraries can set this time limit in the library setting *Holds: Max foreign-circulation time*.  The Library Settings Editor can be found under *Administration -> Local Administration ->  Library Settings Editor*.  
20
21 The Holds-chase-home-lib-patrons option is new in 3.5 and it gives primary ranking to a new weight, _Owning Lib to Patron Home Lib Proximity_, which looks at the proximity between Item Owning Library and Patron Home Library. The remaining default rakings in Holds-chase-home-lib-patrons are in the same order as the default rankings for Traditional with Holds-always-go-home.
22
23 == Create a New Best-Hold Selection Sort Order ==
24 To create a new Best-Hold Selection Sort Order, go to *Administration -> Server Administration ->  Best-Hold Selection Sort Order*.  
25
26 . Click *New Best-Hold Sort Order*.
27 . Assign your Best-Hold Selection Sort Order a *Name*.
28 . Next, use the numeric selectors next to each field to set the order that you would like Evergreen to check when looking for the best hold to fill with an item at opportunistic capture.
29 . Click *Save* to create your custom Best-Hold Selection Sort Order.  
30
31 image::media/new_bhsso.png[New Best-Hold Selection Sort Order]
32
33
34 == Edit an Existing Best-Hold Selection Sort Order ==
35 To edit an existing Best-Hold Selection Sort Order, go to *Administration -> Server Administration ->  Best-Hold Selection Sort Order*.  
36
37 . Find the Sort Order that you want to edit in the grid
38 . Select the row you need to edit and access the _Actions Menu_. The _Actions Menu_ can be accessed in the upper right of the grid or by right-clicking the row.
39 . Choose _Edit Selected_. You can also access the Edit feature by double-clicking on a grid row. 
40 . Next, use the numeric selectors next to each field to set the new order that you would like Evergreen to check when looking for the best hold to fill with an item at opportunistic capture.
41 . Click *Save* to save your edits.  
42
43 image::media/edit_bhsso.png[Edit Best-Hold Selection Sort Order]
44
45 == Choosing the Best-Hold Selection Sort Order ==
46 The Best-Hold Selection Sort Order can be set for an Org Unit in the *Library Settings Editor*.  
47
48 To select the Best-Hold Selection Sort Order that your Org Unit will use:
49
50 . Go to *Administration -> Local Administration ->  Library Settings Editor*.  
51 . Locate the setting *Holds: Best-hold selection sort order*, and click *Edit*.
52 . Choose the *Context* org unit for this setting.
53 . Select the Best-hold selection sort order, or *Value*, from the drop down menu.
54 . Click *Update Setting*. 
55
56 image::media/bhsso_libsetting.png[Best-hold selection in the Library Settings Editor]
57
58
59 == Permissions to use this Feature ==
60 To administer the custom Best-Hold Selection Sort Order interface, you need the following permission:
61
62 * ADMIN_HOLD_CAPTURE_SORT