~evergreen-bugs/evergreen/rel_3_11

« back to all changes in this revision

Viewing changes to docs/modules/admin/pages/Best_Hold_Selection_Sort_Order.adoc

  • Committer: Andrea Buntz Neiman
  • Author(s): Angela Kilsdonk
  • Date: 2023-11-22 20:55:25 UTC
  • Revision ID: git-v1:09b27df26fd31a6472fb3b935ff5b2ddd343e65d
Docs: Update Best_Hold_Selection_Sort_Order.adoc

Added additional BHSSO information from the following Evergreen conference presentation: https://docs.google.com/presentation/d/1iTDaNItUgD33ew57tPTipHEqwI7utxBy-6-jvBoORdE/edit#slide=id.gd947c15582_0_83

Writing credit goes to Angela Kilsdonk from Equinox.

Also added a couple new screenshots. Will upload a new folder of images with new naming conventions.

Signed-off-by: Angela Kilsdonk <akilsdonk@equinoxoli.org>
Signed-off-by: Susan Morrison <smorrison@georgialibraries.org>
Signed-off-by: Andrea Buntz Neiman <abneiman@equinoxinitiative.org>

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
= Best-Hold Selection Sort Order =
3
3
:toc:
4
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
 
 
 
5
When an item is captured for a hold upon check-in, Evergreen evaluates the holds in the system that the item could fill. Evergreen then uses a set of rules, or a Best-Hold Selection Sort Order, to determine the best hold to fill with the item.  Best-Hold Selection Sort Order (BHSSO) allows libraries to configure customized rules, whether by creating new sets of rules or modifying existing ones,  for Evergreen to use to select the best hold to fill at opportunistic capture. These rules is that they answer the question, “What is important to your library when ordering holds to be filled?” BHSSOs are created in *Administration* → *Server Administration* → *Best-Hold Selection Sort Order*. A BHSSO is then set per organizational unit under *Local Administration* → *Library Settings Editor* → *Best-hold selection sort order*.
7
6
 
8
7
== Preconfigured Best-Hold Orders ==
9
8
Evergreen comes with seven preconfigured Best-Hold Selection Sort Orders to choose from:
16
15
* FIFO with Holds-go-home
17
16
* FIFO with Holds-always-go-home
18
17
 
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.
 
18
*Traditional*
 
19
 
 
20
* Uses xref:Org_Unit_Proximity_Adjustments.adoc[Org Unit Proximity] to identify the nearest hold to fill, prioritizing holds where the check-in/capture library is the same as the pickup library.
 
21
* Can help fill holds more efficiently and reduce transit of items.
 
22
* Holds are not filled in order they were placed.
 
23
 
 
24
*FIFO (First In, First Out)*
 
25
 
 
26
* Follows a strict order of first-in, first-out rules.
 
27
* Prioritizes the hold request time and fills holds in order of request time.
 
28
* Can increase transits of items.
 
29
 
 
30
_Holds Go Home_ and _Holds Always Go Home_ 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.  Both Holds Go Home and Holds Always Go Home prioritize holds of patrons at the item-owning library. They can be used with Traditional and FIFO, though with FIFO, this means some holds will not be filled in strict FIFO order.
 
31
 
 
32
*Holds Go Home*
 
33
 
 
34
* If a hold has been placed by a patron at the item’s owning library, and the item has not filled a hold for an owning library patron within the interval configured in “Max foreign-circulation time,” the item will go “home” to fill that patron’s hold.  
 
35
 
 
36
*Holds Always Go Home*
 
37
 
 
38
* If a hold has been placed by a patron at the item’s owning library, the next time the item is captured it will go “home” to fill that patron’s hold.
 
39
 
 
40
*Traditional with Holds-chase-home-patrons*
 
41
 
 
42
* First introduced in 3.5.
 
43
* Gives primary ranking to the Owning Lib to Patron Home Lib Proximity weight, which looks at the proximity between item-owning library and patron home library.
 
44
* Prioritizes holds for patrons whose home library is the same as the item-owning library, regardless of pickup library.
 
45
* This BHSSO may be useful for library systems that resource share and allow patrons to pick up holds at any branch or library within the resource sharing system, but want to ensure that their items are filling holds for their patrons first.
 
46
 
 
47
.Preconfigured Weights for Best-Hold Selection Sort Orders
 
48
[options="header,footer"]
 
49
|=======================
 
50
|ID|Name|Capture Lib to Pickup Lib Proximity|Circ Lib to Request Lib Proximity|Owning Lib to Patron Home Lib Proximity|Adjusted Circ Lib to Pickup Lib Proximity|Adjusted Capture Location to Pickup Lib Proximity|Hold Priority|Hold Cut-in-line State|Hold Selection Depth|Copy Has Circulated From Home Lately|Hold Request Time|Copy Has Been Home At All Lately
 
51
|1|Traditional|2| | |3|1|4|5|6| |7| 
 
52
|2|Traditional with Holds-always-go-home|3|1| |4|2|5|6|7| |8| 
 
53
|3|Traditional with Holds-go-home|3| | |4|2|5|6|7|1|8| 
 
54
|4|FIFO|5|6| |7| |1|2|4|8|3| 
 
55
|5|FIFO with Holds-always-go-home|6|1| |7| |2|3|5|4|8| 
 
56
|6|FIFO with Holds-go-home|6|8| |7| |2|3|5|1|4| 
 
57
|7|Traditional with Holds-chase-home-lib-patrons|4|2|1|5|3|6|7|8| |9| 
 
58
|=======================
 
59
 
 
60
== Best-Hold Selection Sort Order Criteria ==
 
61
 
 
62
* *Adjusted Capture Location to Pickup Lib Proximity* - The adjusted org unit proximity between the capture library and pickup library.
 
63
* *Adjusted Circ Lib to Pickup Lib Proximity* - The adjusted org unit proximity between the circulation library and pickup library.
 
64
* *Capture Lib to Pickup Lib Proximity* - The default org unit proximity between the capture library and pickup library.
 
65
* *Circ Lib to Request Lib Proximity* - The default org unit proximity between the circulating library and request library.
 
66
* *Copy Has Been Home At All Lately* - Tests whether the item has been at its owning library during the time frame set in the Library Settings Editor called “Max foreign-circulation time.”  It looks for * completed transits to the owning library within the time frame specified.
 
67
* *Copy Has Circulated From Home Lately* - Tests whether the item has circulated at its owning library during the time frame set in the Library Settings Editor called “Max foreign-circulation time.” 
 
68
* *Hold Cut-in-line State* - Looks for holds that have been manually set to the top of the holds queue.
 
69
* *Hold Priority* - Looks at the Hold Priority field in the permission group configuration of the user receiving the hold.
 
70
* *Hold Request Time* - Looks at the timestamp for when the hold request was created.
 
71
* *Hold Selection Depth* - For boundary-restricted holds, this prioritizes more restricted holds over less restricted.
 
72
* *Owning Lib to Patron Home Lib Proximity* - The default org unit proximity between the item-owning library and patron home library. 
 
73
 
 
74
The adjusted org unit proximities are determined through *Server Administration* → *Org Unit Proximity Adjustments*.
22
75
 
23
76
== Create a New Best-Hold Selection Sort Order ==
24
77
To create a new Best-Hold Selection Sort Order, go to *Administration -> Server Administration ->  Best-Hold Selection Sort Order*.  
25
78
 
26
79
. Click *New Best-Hold Sort Order*.
 
80
+
 
81
image::Best_Hold_Selection_Sort_Order/create_new_bhsso.png[New Best-Hold Selection Sort Order]
 
82
+
27
83
. Assign your Best-Hold Selection Sort Order a *Name*.
28
84
. 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
85
. Click *Save* to create your custom Best-Hold Selection Sort Order.  
30
86
 
31
 
image::media/new_bhsso.png[New Best-Hold Selection Sort Order]
 
87
image::Best_Hold_Selection_Sort_Order/new_bhsso.png[New Best-Hold Selection Sort Order]
32
88
 
33
89
 
34
90
== Edit an Existing Best-Hold Selection Sort Order ==
37
93
. Find the Sort Order that you want to edit in the grid
38
94
. 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
95
. Choose _Edit Selected_. You can also access the Edit feature by double-clicking on a grid row. 
 
96
+
 
97
image::Best_Hold_Selection_Sort_Order/edit_selected_bhsso.png[Edit Best-Hold Selection Sort Order]
 
98
+
40
99
. 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
100
. Click *Save* to save your edits.  
42
101
 
43
 
image::media/edit_bhsso.png[Edit Best-Hold Selection Sort Order]
 
102
image::Best_Hold_Selection_Sort_Order/edit_bhsso.png[Edit Best-Hold Selection Sort Order]
 
103
 
 
104
=== Tips for Customizing the New Best-Hold Selection Sort Order ===
 
105
 
 
106
* The lower the number, the more important the criteria.
 
107
* Not all criteria need to be used within a BHSSO configuration.
 
108
* Hold Request Time can be viewed as the “tie-breaking” criteria.
44
109
 
45
110
== Choosing the Best-Hold Selection Sort Order ==
46
111
The Best-Hold Selection Sort Order can be set for an Org Unit in the *Library Settings Editor*.  
53
118
. Select the Best-hold selection sort order, or *Value*, from the drop down menu.
54
119
. Click *Update Setting*. 
55
120
 
56
 
image::media/bhsso_libsetting.png[Best-hold selection in the Library Settings Editor]
57
 
 
58
 
 
59
 
== Permissions to use this Feature ==
 
121
image::Best_Hold_Selection_Sort_Order/bhsso_libsetting.png[Best-hold selection in the Library Settings Editor]
 
122
 
 
123
 
 
124
== Permissions to Use This Feature ==
60
125
To administer the custom Best-Hold Selection Sort Order interface, you need the following permission:
61
126
 
62
127
* ADMIN_HOLD_CAPTURE_SORT