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