Docs reorg: splitting self-check documentation into appropriate manuals
[Evergreen.git] / docs / circulation / self_check_configuration.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 * *Block copy checkout status*: Prevent the staff user's permission override
34   from enabling patrons to check out items that they would not normally be able
35   to check out, such as the "On reservation shelf" status. The status IDs are
36   found in the `config.copy_status` database table.
37 * *Patron Login Timeout*: Automatically logs the patron out of the self check
38   after a certain period of inactivity. *NOT CURRENTLY SUPPORTED*
39 * *Pop-up alert for errors*: In addition to displaying an alert message on the
40   screen, this setting raises patron awareness of possible problems by raising
41   an alert box that the patron must dismiss before they can check out another
42   item.
43 * *Require Patron Password*: By default, users can enter either their user name
44   or barcode, without having to enter their password, to access their account.
45   This setting requires patrons to enter their password for additional
46   security.
47 * *Workstation Required*: If set, the URL must either include a
48   `?ws=[workstation]` parameter, where _[workstation]_ is the name of a
49   registered Evergreen workstation, or the staff member must register a new
50   workstation when they login. The workstation parameter ensures that check outs
51   are recorded as occurring at the correct library.
52
53 Using the self check
54 --------------------
55
56 See the circulation manual for documentation about using the self check interface.