2acc06ff439b6488039469b13b51ab317b040ef4
[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 Setting library hours of operation
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 When the self check prints a receipt, the default template includes the
21 library's hours of operation in the receipt. If the library has no configured
22 hours of operation, the attempt to print a receipt fails and the browser hangs.
23
24 Configuring self check behavior
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 Several library settings control the behavior of the self check:
27
28 * *Audio Alerts*: Plays sounds when events occur in the self check. These
29   events are defined in the `templates/circ/selfcheck/audio_config.tt2`
30   template. To use the default sounds, you could run the following command
31   from your Evergreen server as the *root* user (assuming that
32   `/openils/` is your install prefix):
33 +
34 [source, bash]
35 ------------------------------------------------------------------------------
36 cp -r /openils/var/web/xul/server/skin/media/audio /openils/var/web/.
37 ------------------------------------------------------------------------------
38 +
39 * *Block copy checkout status*: Prevent the staff user's permission override
40   from enabling patrons to check out items that they would not normally be able
41   to check out, such as the "On reservation shelf" status. The status IDs are
42   found in the `config.copy_status` database table.
43 * *Patron Login Timeout*: Automatically logs the patron out of the self check
44   after a certain period of inactivity. *NOT CURRENTLY SUPPORTED*
45 * *Pop-up alert for errors*: In addition to displaying an alert message on the
46   screen, this setting raises patron awareness of possible problems by raising
47   an alert box that the patron must dismiss before they can check out another
48   item.
49 * *Require Patron Password*: By default, users can enter either their user name
50   or barcode, without having to enter their password, to access their account.
51   This setting requires patrons to enter their password for additional
52   security.
53 * *Workstation Required*: If set, the URL must either include a
54   `?ws=[workstation]` parameter, where _[workstation]_ is the name of a
55   registered Evergreen workstation, or the staff member must register a new
56   workstation when they login. The workstation parameter ensures that check outs
57   are recorded as occurring at the correct library.
58
59 Checking out or renewing items in the self check
60 ------------------------------------------------
61 After a staff user has logged into the self check interface, the interface
62 is ready for patrons to log in and check out or renew items.
63
64 . The patron logs in by entering either their patron barcode or their user name.
65 . The patron enters the barcode for each item. If the patron types the barcode,
66   they need to press the `<Enter>` key to check out the item. The item details,
67   including due date, appear below the barcode field.
68 . When the patron is finished, they can click *Logout* if they want a receipt
69   for their items, or *Logout (no receipt)* if they prefer no receipt.