Docs: updating booking admin for the Web client
[Evergreen.git] / docs / admin / booking-admin.adoc
1 Booking Module Administration
2 -----------------------------
3
4 Creating Bookable Non-Bibliographic Resources
5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
7 Staff with the required permissions (Circulator and above) can create bookable non-bibliographic resources such as laptops, projectors, and meeting rooms.
8
9 The following pieces make up a non-bibliographic resource:
10
11 * Resource Type
12 * Resource Attribute
13 * Resource Attribute Values
14 * Resource
15 * Resource Attribute Map
16
17 You need to create resource types and resource attributes (features of the resource types), and add booking items (resources) to individual resource type. Each resource attribute may have multiple values. You need to link the applicable features (resource attributes and values) to individual item (resource) through the Resource Attribute Map. Before you create resources (booking items) you need to have a resource type and associated resource attributes and values, if any, for them.
18
19 Create New Resource Type
20 ^^^^^^^^^^^^^^^^^^^^^^^^
21
22 1) Select Administration -> Booking Administration -> Resource Types.
23
24 image::media/booking-create-resourcetype_webclient-1.png[]
25
26 2) A list of current resource types will appear. Use Back and Next buttons to browse the whole list.
27
28 image::media/booking-create-resourcetype-2.png[]
29
30 [NOTE]
31 You may also see cataloged items in the list. Those items have been marked bookable or booked before.
32
33
34 3) To create a new resource type, click New Resource Type in the top right corner, .
35
36 image::media/booking-create-resourcetype-3.png[]
37
38 4) A box will appear in which you create your new type of resource.
39
40 image::media/booking-create-bookable-1.png[]
41
42 * Resource Type Name - Give your resource a name.
43 * Fine Interval - How often will fines be charged? This period can be input in several ways:
44
45 [NOTE]
46 ====================================================================
47 ** second(s), minute(s), hour(s), day(s), week(s), month(s), year(s)
48 ** sec(s), min(s)
49 ** s, m, h
50 ** 00:00:30, 00:01:00, 01:00:00
51 ===================================================================
52
53 * Fine Amount - The amount that will be charged at each Fine Interval.
54 * Owning Library - The home library of the resource.
55 * Catalog Item - (Function not currently available.)
56 * Transferable - This allows the item to be transferred between libraries.
57 * Inter-booking and Inter-circulation Interval - The amount of time required by your library between the return of a resource and a new reservation for the resource. This interval uses * the same input conventions as the Fine Interval.
58 * Max Fine Amount - The amount at which fines will stop generating.
59
60 5) Click Save when you have entered the needed information.
61
62 image::media/booking-create-resourcetype-4.png[]
63
64 6) The new resource type will appear in the list.
65
66 image::media/booking-create-resourcetype-5.png[]
67
68 Create New Resource Attribute
69 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
70
71 1) Select Administration -> Booking Administration -> Resource Attributes.
72
73 2) Click New Resource Attribute in the top right corner.
74
75 3) A box will appear in which you can add the attributes of the resource. Attributes are categories of descriptive information that are provided to the staff member when the booking request is made. For example, an attribute of a projector may be the type of projector. Other attributes might be the number of seats available in a room, or the computing platform of a laptop.
76
77 image::media/booking-create-bookable-2.png[]
78
79 * Resource Attribute Name - Give your attribute a name.
80 * Owning Library - The home library of the resource.
81 * Resource Type - Type in the first letter to list then choose the Resource Type to which the Attribute is applicable.
82 * Is Required - (Function not currently available.)
83
84 4) Click Save when the necessary information has been entered.
85
86 5) The added attribute will appear in the list.
87
88 [NOTE]
89 One resource type may have multiple attributes. You may repeat the above procedure to add more.
90
91 Create New Resource Attribute Value
92 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
93
94 1) One resource attribute may have multiple values. To add new attribute value, select Administration -> Booking Administration -> Resource Attribute Values.
95
96 2) Click New Resource Attribute Value in the top right corner.
97
98 3) A box will appear in which you assign a value to a particular attribute. Values can be numbers, words, or a combination of them, that describe the particular aspects of the resource that have been defined as Attributes. As all values appear on the same list for selection, values should be as unique as possible. For example, a laptop may have a computing platform that is either PC or Mac.
99
100 image::media/booking-create-bookable-3.png[]
101
102 * Owning Library - The home library of the resource.
103 * Resource Attribute - The attribute you wish to assign the value to.
104 * Valid Value - Enter the value for your attribute.
105
106 4) Click Save when the required information has been added.
107
108 5) The attribute value will appear in the list. Each attribute should have at least two values attached to it; repeat this process for all applicable attribute values.
109
110 Create New Resource
111 ^^^^^^^^^^^^^^^^^^^
112
113 1) Add items to a resource type. Click Administration -> Booking Administration -> Resources.
114
115 2) Click New Resource in the top right corner.
116
117 3) A box will appear. Add information for the resource.
118
119 image::media/booking-create-bookable-4.png[]
120
121 * Owning Library - The home library of the resource.
122 * Resource Type - Type in the first letter of the resource type's name to list then select the resource type for your item.
123 * Barcode - Barcode for the resource.
124 * Overbook - This allows a single item to be reserved, picked up, and returned by multiple patrons during overlapping or identical time periods.
125 * Is Deposit Required - (Function not currently available.)
126 * Deposit Amount - (Function not currently available.)
127 * User Fee - (Function not currently available.)
128
129 4) Click Save when the required information has been added.
130
131 5) The resource will appear in the list.
132
133 [NOTE]
134 One resource type may have multiple resources attached.
135
136 Map Resource Attributes and Values to Resources
137 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138
139 1) Use Resource Attribute Maps to bring together the resources and their attributes and values. Select Administration -> Booking Administration -> Resource Attribute Maps.
140
141 2) Click New Resource Attribute Map in the right top corner.
142
143 3) A box will appear in which you will map your attributes and values to your resources.
144
145 image::media/booking-create-bookable-5.png[]
146
147 * Resource - Enter the barcode of your resource.
148 * Resource Attribute - Select an attribute that belongs to the Resource Type.
149 * Attribute Value - Select a value that belongs to your chosen attribute and describes your resource. If your attribute and value do not belong together you will be unable to save.
150
151 4) Click Save once you have entered the required information.
152
153 [NOTE]    
154 A resource may have multiple attributes and values. Repeat the above steps to map all.
155
156 5) The resource attribute map will appear in the list.
157
158 Once all attributes have been mapped your resource will be part of a hierarchy similar to the example below.
159
160 image::media/booking-create-bookable-6.png[]
161
162
163 Editing Non-Bibliographic Resources
164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165
166 Staff with the required permissions can edit aspects of existing non-bibliographic resources. For example, resource type can be edited in the event that the fine amount for a laptop changes from $2.00 to $5.00.
167
168 Editing Resource Types
169 ^^^^^^^^^^^^^^^^^^^^^^
170
171 1) Bring up your list of resource types. Select Administration -> Booking Administration -> Resource Types.
172
173 2) A list of current resource types will appear.
174
175 3) Double click anywhere on the line of the resource type you would like to edit.
176
177 4) The resource type box will appear. Make your changes and click Save.
178
179 5) Following the same procedure you may edit Resource Attributes, Attributes Values, Resources and Attribute Map by selecting them on Administration -> Booking Administration.
180
181
182
183
184 Deleting Non-bibliographic Resources
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
186
187 1) To delete a booking resource, go to Administration -> Booking Administration -> Resources.
188
189 2) Select the checkbox in front the resource you want to delete. Click Delete Selected. The resource will disappear from the list.
190
191 Following the same procedure you may delete Resource Attributes Maps.
192
193 You may also delete Resource Attribute Values, Resource Attributes and Resource Types. But you have to delete them in the reverse order when you create them to make sure the entry is not in use when you try to delete it.
194
195 This is the deletion order: Resource Attribute Map/Resources -> Resource Attribute Values -> Resource Attributes -> Resource Types. 
196
197
198
199