Docs: Batch actions from search
[Evergreen.git] / docs / opac / batch_actions_from_search.adoc
1 Batch Actions from Search
2 -------------------------
3
4 Introduction
5 ~~~~~~~~~~~~
6
7 The public catalog and staff interface display checkboxes on the search results pages, both for bibliographic records and metarecord constituents.  Selecting one or more titles with these checkboxes adds the titles to a basket, which is viewable on the search bar as an icon.  Users can then take a variety of actions on titles within the basket:  place holds, print or email title details, add the items to a permanent list (from the public catalog) or add the titles to a bucket (from the staff interface).
8
9
10 Using Batch Actions from Search in the Public Catalog
11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12
13 . Perform a search in the public catalog and retrieve a list of results.  
14 +
15 Checkboxes appear to the left of the number of each result.  In the case of a metarecord search, checkboxes only appear on the list of metarecord constituents, as metarecords themselves cannot be placed in lists or in baskets.  If you want to place the entire page of results on the list, click the _Select All_ checkbox at the top of the results list. 
16 +
17  
18 . Select one or more titles from the results list by clicking on the checkboxes. 
19 +
20 Selected titles are automatically added to the basket. A link above the results list tracks the number of titles selected and added to the basket.
21 +
22 image::media/BatchActionsSearch-01.png[Selecting Search Results]
23 +
24
25 . The number of items can also be found with the basket icon above the search bar, next to the _Basket Actions_ drop-down.
26
27 image::media/BatchActionsSearch-02.png[Basket Actions Drop-down]
28 +
29
30 . Click on the _Basket Actions_ drop-down next to the basket icon to take any of the following actions on titles within the basket: View Basket, Place Hold, Print Title Details, Email Title Details, Add Basket to Saved List, Clear Basket.
31
32 image::media/BatchActionsSearch-03.png[Details of Basket Actions Drop-down]
33
34
35 Actions Initiated with the Basket Actions Drop-down
36 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
37 * *View Basket* - This opens the basket in a new screen.  Checkboxes allow for the selection of one or more titles within the basket.  A drop-down menu appears above the list of titles that can be used to place holds, print title details, email title details, or remove titles from the basket.  This menu reads _Actions for these items_.  (See the next section for more information about this menu.)
38
39 * *Place Hold* - This allows for placement of holds in batch for all of the items in the basket.  If not already authenticated, users will be asked to login.  Once authenticated, the holds process begins for all titles within the basket.  Users can set _Advanced Hold Options_ for each title, as well as set the pickup location, hold notification and suspend options.  
40
41 * *Print Title Details* - This allows for printing details of all titles within the basket.  A confirmation page opens prior to printing that includes a checkbox option for clearing the basket after printing.  
42
43 * *Email Title Details* - This allows for emailing details of all titles within the basket.  If not already authenticated, users will be asked to login.  Once authenticated, the email process begins.  A confirmation page opens prior to printing that includes a checkbox option for clearing the basket after emailing. 
44
45 * *Add Basket to Saved List* - This allows basket items to be saved to a new permanent list. If not already authenticated, users will be asked to login.  Once authenticated, the creation of a new permanent list begins.    
46
47 * *Clear Basket* - This removes removes all titles from the basket
48
49 View Basket -> _Actions for These Items_ Drop-down Menu
50 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51 Most actions described above can be taken on titles from within the basket with the _Actions for these items_ drop-down menu.  This menu offers additional flexibility, as users can select some or all of the individual titles in the basket on which to place holds, print or email details, or remove from the basket.  Users cannot add titles to permanent lists with this menu.
52  
53 image::media/BatchActionsSearch-04.png[Actions for These Items Drop-down Menu]
54
55 Using Batch Actions from Search in the Staff Interface
56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
58 . Perform a search in the staff interface and retrieve a list of results.  
59 +
60 Checkboxes appear to the left of the number of each result.  In the case of a metarecord search, checkboxes only appear on the list of metarecord constituents, as metarecords themselves cannot be placed in lists or in baskets.  If you want to place the entire page of results on the list, click the Select All checkbox at the top of the results list. 
61 +
62
63 . Select one or more titles from the results list by clicking on the checkboxes. Selected titles are automatically added to the basket. A link above the results list tracks the number of titles selected and added to the basket. 
64 +
65 image::media/BatchActionsSearch-01.png[Selecting Search Results]
66 +
67
68 . The number of items can also be found with the basket icon above the search bar, next to the _Basket Actions_ drop-down.
69
70 image::media/BatchActionsSearch-02.png[Basket Actions Drop-down]
71 +
72
73 . Click on the _Basket Actions_ drop-down next to the basket icon to take any of the following actions on titles within the basket: View Basket, Place Hold, Print Title Details, Email Title Details, Add Basket to Saved List, Clear Basket.
74
75 image::media/BatchActionsSearch-03.png[Details of Basket Actions Drop-down]
76
77
78 Actions Initiated with the Basket Actions Drop-down
79 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
80
81 * *View Basket* - This opens the basket in a new screen.  Checkboxes allow for the selection of one or more titles within the basket.  A drop-down menu appears above the list of titles that can be used to place holds, print title details, email title details, or remove titles from the basket.  This menu reads _Actions for these items_.  (See the next section for more information about this menu.)
82
83 * *Place Hold* - This allows for placement of holds in batch for all of the items in the basket. When initiated, the holds process begins for all titles within the basket.  Staff can set _Advanced Hold Options_ for each title placed on hold, as well as set the pickup location, hold notification and suspend options.  
84
85 * *Print Title Details* - This allows for printing details of all titles within the basket.  A confirmation page opens prior to printing that includes a checkbox option for clearing the basket after printing.  
86
87 * *Email Title Details* - This allows for emailing details of all titles within the basket.  A confirmation page opens prior to printing that includes a checkbox option for clearing the basket after printing. 
88
89 * *Add Basket to Bucket* - This allows for titles within the basket to be added to an existing or new Record Bucket.
90 ** Click the _Basket Actions_ drop-down and choose _Add Basket to Bucket_
91 ** To add the titles in your basket to an existing bucket, select the bucket from the _Name of existing bucket_ dropdown and click _Add to Select Bucket_.
92 ** To add the titles in your basket to a new bucket, enter the name of your new bucket in the text box and click _Add to New Bucket_.
93 +
94 image::media/BatchActionsSearch-06.png[Add Basket Titles to Bucket]
95 +
96 * *Clear Basket* - removes all items from the basket
97
98
99 View Basket -> Actions for These Items Drop-down Menu
100 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
101
102 Most of the basket actions can be taken on titles from within the basket with the _Actions for these items_ drop-down menu.  This menu offers additional flexibility, as staff can select some or all of the individual titles within the basket on which to place holds, print or email details, or remove from the basket.  Staff cannot place titles in Records Buckets from this menu.
103
104 Additional Information
105 ~~~~~~~~~~~~~~~~~~~~~~
106
107 The basket used to be called a *Temporary List* in previous versions of Evergreen.
108
109 Titles also may be added from the detailed bibliographic record with the _Add to Basket_ link.
110
111 Javascript must be enabled for checkboxes to appear in the public catalog; however, users can still add items to the basket and perform batch actions without Javascript.
112
113 The default limit on the number of basket titles is 500; however, a template config.tt2 setting (+ctx.max_basket_size+) can be used to set a different limit.  When the configured limit is reached, checkboxes are disabled unless or until some titles in the basket are removed.
114
115 The permanent list management page within a patron’s account also now includes batch print and email actions.