Add admin-booking module contributed by Jeremy Buhler.
[working/Evergreen.git] / 1.6 / admin / admin-booking.xml
1 <?xml version='1.0' encoding='UTF-8'?>\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
3    xml:lang="EN" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="admin-booking">\r
4    <info>\r
5       <title>Booking Module Administration</title>\r
6       <legalnotice>\r
7          <para><emphasis role="bold">Adapted with permission from original material by the <link\r
8                   xlink:title="http://docs.evergreen-ils.org/1.6/draft/html/"\r
9                   xlink:href="http://docs.evergreen-ils.org/1.6/draft/html/">Evergreen\r
10                   Community</link></emphasis></para>\r
11       </legalnotice>\r
12 \r
13       <abstract>\r
14          <para>The Evergreen booking module is included in Evergreen 1.6.1.x and above.The following\r
15             documentation will include information about making cataloged items bookable; making\r
16             non-bibliographic items bookable; and setting permissions in the booking module for\r
17             staff.</para>\r
18       </abstract>\r
19    </info>\r
20    <section xml:id="MakeCataloguedItemBookable">\r
21       <title>Make a Cataloged Item Bookable in Advance</title>\r
22       <para>If their permission settings allow, staff members can make items bookable. Staff members\r
23          can do this in advance of a booking request, or they can do it on the fly.</para>\r
24       <para>If you know in advance of the request that an item will need to be booked, you can make\r
25          the item bookable.</para>\r
26 \r
27 \r
28       <procedure>\r
29          <step>\r
30             <para>In the staff client, select <menuchoice>\r
31                   <guimenu>Search</guimenu>\r
32                   <guimenuitem>Search the Catalog</guimenuitem>\r
33                </menuchoice></para>\r
34          </step>\r
35          <step>\r
36             <para>Begin a title search to find an item.</para>\r
37          </step>\r
38          <step>\r
39             <para>Click the title of the item that you want to book.</para>\r
40          </step>\r
41 \r
42          <step>\r
43             <para>The <guilabel>Record Summary</guilabel> will appear. In this view you can see\r
44                information about the item and its locations. Click <menuchoice>\r
45                   <guimenu>Actions for this Record</guimenu>\r
46                   <guimenuitem>Holdings Maintenance</guimenuitem>\r
47                </menuchoice> in the top right corner of the screen.</para>\r
48          </step>\r
49 \r
50          <step>\r
51             <para>The <guilabel>Holdings Maintenance</guilabel> screen will appear. In this screen,\r
52                you can view the volumes and copies of an item avaialable at each branch. To view the\r
53                barcodes and other information for each copy, click the arrow adjacent to the branch\r
54                with the copy that you need to view. Click on successive arrows until you find the\r
55                copy that you need to view.</para>\r
56          </step>\r
57          <step>\r
58             <para>Select the item that you want to make bookable. Right click to open the menu, and\r
59                click <guimenuitem>Make Item Bookable</guimenuitem>.</para>\r
60          </step>\r
61          <step>\r
62             <para>The item has now been added to the list of resources that are bookable. To book\r
63                the item, return to the <guilabel>Record Summary</guilabel>, and proceed with\r
64                booking..</para>\r
65          </step>\r
66 \r
67       </procedure>\r
68       <note>\r
69          <para>In Evergreen 1.6.1, there is no way to make an item “unbookable” after it has been\r
70             made bookable and has been reserved. The <guibutton>Delete Selected</guibutton> button\r
71             on this screen deletes the resource from the screen, but the item will be able to be\r
72             booked after it has been returned.</para>\r
73       </note>\r
74 \r
75    </section>\r
76    <section xml:id="MakeItemBookableOnTheFly">\r
77       <title>Make a Cataloged Item Bookable On the Fly</title>\r
78       <para>If a patron wants to book an item immediately that does not have bookable status, you\r
79          can book the item on the fly if you have the appropriate permissions.</para>\r
80 \r
81       <procedure>\r
82          <step>\r
83             <para>Follow steps one through five in <xref linkend="MakeCataloguedItemBookable"\r
84                />.</para>\r
85          </step>\r
86          <step>\r
87             <para>Select the item that you want to make bookable. Right click to open the menu, and\r
88                click <guimenuitem>Book Item Now</guimenuitem>.</para>\r
89          </step>\r
90          <step>\r
91             <para>A <guilabel>Reservations</guilabel> screen will appear in a new tab, and you can\r
92                make the reservation.</para>\r
93          </step>\r
94 \r
95       </procedure>\r
96 \r
97    </section>\r
98    <section xml:id="MakeNon-CataloguedItemBookable">\r
99       <title>Create a Bookable Status for Non-Bibliographic Items</title>\r
100       <para>Staff with the required permissions can create a bookable status for non-bibliographic\r
101          items. For example, staff can book conference rooms or laptops. You will be able to create\r
102          types of resources, specify the names of individual resources within each type, and set\r
103          attributes to describe those resources. You can then bring the values together through the\r
104             <guilabel>Resource Attribute Map</guilabel>.</para>\r
105       <procedure>\r
106          <step>\r
107             <para>First, create the type of resource that you want to make bookable. Select <menuchoice>\r
108                   <guimenu>Admin</guimenu>\r
109                   <guisubmenu>Server Administration</guisubmenu>\r
110                   <guisubmenu>Booking</guisubmenu>\r
111                   <guimenuitem>Resource Types</guimenuitem>\r
112                </menuchoice>.</para>\r
113          </step>\r
114          <step>\r
115             <para>A list of resource types will appear. You may also see titles of cataloged items\r
116                on this screen if they were added using the <guilabel>Make Item Bookable</guilabel>\r
117                or <guilabel>Book Now</guilabel> links. You should not attempt to add cataloged items\r
118                on this screen; it is best to use the aforementioned links to make those items\r
119                bookable. In this screen, you will create a type of resource.</para>\r
120          </step>\r
121          <step>\r
122             <para>In the right corner, click <guibutton>New Resource Type</guibutton>.</para>\r
123          </step>\r
124          <step>\r
125             <para>A box will appear in which you will create a type of resource. In this box, you\r
126                can set fines, determine “elbow room” periods between reservations on this type of\r
127                resource, and indicate if this type of resource can be transferred to another\r
128                library. Click <guibutton>Save</guibutton> when you have entered the needed\r
129                information.</para>\r
130          </step>\r
131          <step>\r
132             <para>After you click <guibutton>Save</guibutton>, the box will disappear. Refresh the\r
133                screen to see the item that you have added.</para>\r
134          </step>\r
135          <step>\r
136             <para>Next, set the attributes for the type of resource that you have created. Select <menuchoice>\r
137                   <guimenu>Server Administration</guimenu>\r
138                   <guisubmenu>Booking</guisubmenu>\r
139                   <guimenuitem>Resource Attributes</guimenuitem>\r
140                </menuchoice>.</para>\r
141          </step>\r
142 \r
143          <step>\r
144             <para>Click <guibutton>New Resource Attribute</guibutton>.</para>\r
145          </step>\r
146 \r
147          <step>\r
148             <para>A box will appear in which you can add the attributes of the resource. Attributes\r
149                are descriptive information that is provided to the staff member when the booking\r
150                request is made. For example, an attribute of the projector may be a cart that allows\r
151                for its transportation. Other attributes might be number of seats available in a\r
152                room, or MAC or PC attributes for a laptop. Click <guibutton>Save</guibutton> when\r
153                the necessary information has been entered.</para>\r
154          </step>\r
155 \r
156          <step>\r
157             <para>The box will disappear. Refresh the screen to see the added attribute.</para>\r
158          </step>\r
159 \r
160          <step>\r
161             <para>Next, add the values for the resource attributes. A value can be a number, yes/no,\r
162                or any other meaningful information. Select <menuchoice>\r
163                   <guimenu>Server Administration</guimenu>\r
164                   <guisubmenu>Booking</guisubmenu>\r
165                   <guimenuitem>Resource Attribute Values</guimenuitem>\r
166                </menuchoice>.</para>\r
167          </step>\r
168 \r
169          <step>\r
170             <para>Select <guibutton>New Resource Attribute Value</guibutton>.</para>\r
171          </step>\r
172 \r
173          <step>\r
174             <para>A pop up box will appear. Select the <guilabel>Resource Attribute</guilabel> from\r
175                the drop down box. Add the value. You can add multiple values for this field. Click\r
176                   <guibutton>Save</guibutton> when the required information has been added.</para>\r
177          </step>\r
178 \r
179          <step>\r
180             <para>If you refresh the screen, the attribute value may not appear, but it has been\r
181                saved.</para>\r
182          </step>\r
183 \r
184          <step>\r
185             <para>Next, identify the specific objects that are associated with this resource type.\r
186                Click <menuchoice>\r
187                   <guimenu>Admin</guimenu>\r
188                   <guisubmenu>Server Administration</guisubmenu>\r
189                   <guisubmenu>Booking</guisubmenu>\r
190                   <guimenuitem>Resources</guimenuitem>\r
191                </menuchoice>.</para>\r
192          </step>\r
193 \r
194          <step>\r
195             <para>Click <guibutton>New Resource</guibutton>.</para>\r
196          </step>\r
197 \r
198          <step>\r
199             <para>A pop-up box will appear. Add information for the resource and click\r
200                   <guibutton>Save</guibutton>. Repeat this process for each resource.</para>\r
201          </step>\r
202 \r
203          <step>\r
204             <para>Refresh the screen, and the resource(s) that you added will appear.</para>\r
205          </step>\r
206 \r
207          <step>\r
208             <para>Finally, use <guilabel>Resource Attribute Maps</guilabel> to bring together the\r
209                resource and its attributes. Select <menuchoice>\r
210                   <guimenu>Admin</guimenu>\r
211                   <guisubmenu>Server Administration</guisubmenu>\r
212                   <guisubmenu>Booking</guisubmenu>\r
213                   <guimenuitem>Resource Attribute Maps</guimenuitem>\r
214                </menuchoice>.</para>\r
215          </step>\r
216 \r
217          <step>\r
218             <para>Select <guibutton>New Resource Attribute Map</guibutton></para>\r
219          </step>\r
220 \r
221          <step>\r
222             <para>Select the resource that you want to match with its attributes, then click\r
223                   <guibutton>Save</guibutton>. Repeat for all applicable resources.</para>\r
224          </step>\r
225 \r
226          <step>\r
227             <para>You have now created bookable, non-bibliographic resource(s) with\r
228                attributes.</para>\r
229          </step>\r
230 \r
231       </procedure>\r
232    </section>\r
233    <section xml:id="SettingBookingPermissions">\r
234       <title>Setting Booking Permissions</title>\r
235       <para>Administrators can set permissions so that staff members can view reservations, make\r
236          reservations, and make bibliographic or non-bibliographic items bookable.</para>\r
237 \r
238       <para>If a staff member attempts to book an item for which they do not have the appropriate\r
239          permissions, they will receive an error message.</para>\r
240 \r
241       <para>To set permissions, select <menuchoice>\r
242             <guimenu>Admin</guimenu>\r
243             <guisubmenu>Server Administration</guisubmenu>\r
244             <guimenuitem>Permissions</guimenuitem>\r
245          </menuchoice>.</para>\r
246 \r
247       <para>Staff members should be assigned the following permissions to do common tasks in the\r
248          booking module. These permissions could be assigned to front line staff members, such as\r
249          circulation staff. Permissions with an asterisk (<emphasis role="bold">*</emphasis>) are\r
250          already included in the <emphasis role="bold">Staff</emphasis> permission group. All other\r
251          booking permissions must be applied individually.</para>\r
252 \r
253       <itemizedlist>\r
254          <listitem>\r
255             <para><emphasis role="bold">View Reservations:</emphasis> VIEW_TRANSACTION*</para>\r
256          </listitem>\r
257          <listitem>\r
258             <para><emphasis role="bold">Use the pull list:</emphasis>\r
259                RETRIEVE_RESERVATION_PULL_LIST</para>\r
260          </listitem>\r
261          <listitem>\r
262             <para><emphasis role="bold">Capture reservations:</emphasis> CAPTURE_RESERVATION</para>\r
263          </listitem>\r
264          <listitem>\r
265             <para><emphasis role="bold">Assist patrons with pickup and return:</emphasis>\r
266                VIEW_USER*</para>\r
267          </listitem>\r
268          <listitem>\r
269             <para><emphasis role="bold">Create/update/delete reservations:</emphasis>\r
270                ADMIN_BOOKING_RESERVATION</para>\r
271          </listitem>\r
272       </itemizedlist>\r
273 \r
274       <para>The following permissions allow users to do more advanced tasks, such as making items\r
275          bookable, booking items on the fly, and creating non-bibliographic resources for\r
276          booking.</para>\r
277 \r
278       <itemizedlist>\r
279          <listitem>\r
280             <para><emphasis role="bold">Create/update/delete booking resource type:</emphasis>\r
281                ADMIN_BOOKING_RESOURCE_TYPE</para>\r
282          </listitem>\r
283          <listitem>\r
284             <para><emphasis role="bold">Create/update/delete booking resource attributes:</emphasis>\r
285                ADMIN_BOOKING_RESOURCE_ATTR</para>\r
286          </listitem>\r
287          <listitem>\r
288             <para><emphasis role="bold">Create/update/delete booking resource attribute\r
289                   values:</emphasis> ADMIN_BOOKING_RESOURCE_ATTR_VALUE</para>\r
290          </listitem>\r
291          <listitem>\r
292             <para><emphasis role="bold">Create/update/delete booking resource:</emphasis>\r
293                ADMIN_BOOKING_RESOURCE</para>\r
294          </listitem>\r
295          <listitem>\r
296             <para><emphasis role="bold">Create/update/delete booking resource attribute\r
297                   maps:</emphasis> ADMIN_BOOKING_RESOURCE_ATTR_MAP</para>\r
298          </listitem>\r
299       </itemizedlist>\r
300 \r
301       <para>In addition to having the permissions listed above, staff members will need a valid\r
302          working location in their profiles. This should be done when registering new staff members.</para>\r
303 \r
304       <!-- Pages 14-16 of source document from http://evergreen-ils.org/dokuwiki/doku.php?id=booking ommitted at conversion (Jeremy Buhler, Oct 6 2010).  Rationale: subject is covered elsewhere in the Book of Evergreen and it confuses 'working location' with 'home library', both of which should already be set for all staff accounts. -->\r
305 \r
306    </section>\r
307 </chapter>\r