]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/circulation/self_check.adoc
ba963548b2c6ac9526854189f7f5a630bfb3548a
[Evergreen.git] / docs / circulation / self_check.adoc
1 Self checkout
2 =============
3
4 Introduction
5 ------------
6
7 Evergreen includes a self check interface designed for libraries that simply
8 want to record item circulation without worrying about security mechanisms like
9 magnetic strips or RFID tags.
10
11 Initializing the self check
12 ---------------------------
13 The self check interface runs in a web browser. Before patrons can use the self
14 check station, a staff member must initialize the interface by logging in.
15
16 . Open your self check interface page in a web browser. By default, the URL is
17   `https://[hostname]/eg/circ/selfcheck/main`, where _[hostname]_
18   represents the host name of your Evergreen web server.
19 . Log in with a staff account with circulation permissions.
20
21 image::media/self-check-admin-login.png[Self Check Admin Login]
22
23 Setting library hours of operation
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 When the self check prints a receipt, the default template includes the
26 library's hours of operation in the receipt. If the library has no configured
27 hours of operation, the attempt to print a receipt fails and the browser hangs.
28
29 Configuring self check behavior
30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31 Several library settings control the behavior of the self check:
32
33 * *Audio Alerts*: Plays sounds when events occur in the self check. These
34   events are defined in the `templates/circ/selfcheck/audio_config.tt2`
35   template. To use the default sounds, you could run the following command
36   from your Evergreen server as the *root* user (assuming that
37   `/openils/` is your install prefix):
38 +
39 [source, bash]
40 ------------------------------------------------------------------------------
41 cp -r /openils/var/web/xul/server/skin/media/audio /openils/var/web/.
42 ------------------------------------------------------------------------------
43 +
44 * *Block copy checkout status*: Prevent the staff user's permission override
45   from enabling patrons to check out items that they would not normally be able
46   to check out, such as the "On reservation shelf" status. The status IDs are
47   found in the `config.copy_status` database table.
48 * *Patron Login Timeout*: Automatically logs the patron out of the self check
49   after a certain period of inactivity. *NOT CURRENTLY SUPPORTED*
50 * *Pop-up alert for errors*: In addition to displaying an alert message on the
51   screen, this setting raises patron awareness of possible problems by raising
52   an alert box that the patron must dismiss before they can check out another
53   item.
54 * *Require Patron Password*: By default, users can enter either their user name
55   or barcode, without having to enter their password, to access their account.
56   This setting requires patrons to enter their password for additional
57   security.
58 * *Workstation Required*: If set, the URL must either include a
59   `?ws=[workstation]` parameter, where _[workstation]_ is the name of a
60   registered Evergreen workstation, or the staff member must register a new
61   workstation when they login. The workstation parameter ensures that check outs
62   are recorded as occurring at the correct library.
63
64 Basic Check Out
65 ---------------
66
67 . Patron scans their barcode.
68 +
69 image::media/self_check_check_out_1.png[self check]
70 +               
71 . _Optional_ Patron enters their account password.
72 +
73 image::media/self_check_check_out_2.png[self check]
74 +
75 . Patron scans the barcodes for their items
76 _OR_
77 Patron places items, one at a time, on the RFID pad.
78 +
79 image::media/self_check_check_out_3.png[self check]
80 +               
81 . Items will be listed below with a check out confirmation message.
82 +
83 image::media/self_check_check_out_4.png[self check]
84 +
85 . If a check out fails a message will advise patrons.
86 +
87 image::media/self_check_error_1.png[self check]
88 +
89 . Patron clicks *Logout* to print a checkout receipt and logout.
90 _OR_
91 Patron clicks *Logout (No Receipt)* to logout with no receipt.
92 +
93 image::media/self_check_check_out_5.png[self check]
94 +                       
95 [NOTE]
96 ==========
97 If the patron forgets to logout the system will automatically log out after the time
98 period specified in the library setting *Patron Login Timeout (in seconds)*.  An inactivity pop-up
99 will appear to warn patrons 20 seconds before logging out.
100
101 image::media/self_check_check_out_6.png[self check]
102 ==========
103
104 View Items Out
105 --------------
106
107 . Patrons are able to view the items they currently have checked out by clicking *View Items Out*
108 +
109 image::media/self_check_view_items_out_1.png[self check]
110 +               
111 . The items currently checked out will display with their due dates.
112 Using the *Print List* button patrons can 
113 print out a receipt listing all of the items they currently have checked out.
114
115 image::media/self_check_view_items_out_2.png[self check]
116
117
118 View Holds
119 ----------
120
121 . Patrons are able to view their current holds by clicking *View Holds*
122 +
123 image::media/self_check_view_holds_1.png[self check]
124 +                 
125 . Items currently on hold display.  Patrons can also see which, if any, items are ready for pickup.
126 +
127 Using the *Print List* button patrons can print out a receipt listing all of the items they currently have on hold.
128 +
129 image::media/self_check_view_holds_2.png[self check]
130
131 View Fines
132 ----------
133
134 . Patrons are able to view the fines they currently owe by clicking *View Details*
135 +
136 image::media/self_check_view_fines_1.png[self check]
137 +
138 . Current fines owed by the patron display. 
139
140 image::media/self_check_view_fines_2.png[self check]