Documentation: Removed bare setting names from Stripe payment doc
[working/Evergreen.git] / docs / admin / lsa-library_settings_editor.txt
1 Library Settings Editor
2 -----------------------
3 [[library_settings_editor]]
4
5 Fine Accrual on Closed Dates
6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7
8 By default, fines accrue only on dates that the library is open.  This feature
9 enables you to charge patrons fines on dates the library is closed. Fines accrue
10 during scheduled closings as well as during normal weekly closed dates.
11
12 To enable this feature:
13
14 . Click *Admin* -> *Local Administration* -> *Library Settings* -> *Charge fines
15 on overdue circulations when closed*
16 . Click *Edit*.
17 . Set the value to *True*.
18 . Click *Update Setting*.   
19
20
21 Target Copies for Holds at Closed Libraries
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23
24 By default, when a patron places a hold on a title, the hold targeter will
25 search for copies to fill the hold only at circulating libraries that are open.
26 Copies at closed libraries are not targeted to fill holds. When turned on, this
27 feature enables Evergreen to target copies that have closed circulating
28 libraries to fill holds. Two new org unit settings control this feature.
29
30 Use the following setting to target copies for holds at closed circulating libraries:
31
32 . Click *Admin* -> *Local Administration* -> *Library Settings Editor* ->
33 *Target copies for a hold even if copy's circ lib is closed* . Set the value to
34 *True* if you want to target copies for holds at closed circulating libraries.
35 Set the value to *False*, or leave it unset, if you do not want to enable this
36 feature.
37 . Click *Update Setting*.
38
39 image::media/Target_Pickup_Lib1.jpg[Target_Pickup_Lib1]
40
41 Use the following setting to target copies for holds IF AND ONLY IF the
42 circulating library is the hold's pickup library.
43
44 . Click *Admin* -> *Local Administration* -> *Library Settings Editor* ->
45 *Target copies for a hold even if copy's circ lib is closed IF the circ lib is
46 the hold's pickup lib* . Set the value to *True* if you want to target copies
47 for holds at closed circulating libraries when the circulating library of the
48 item and the pickup library of the hold are 
49 the same. Set the value to *False*, or leave it unset, if you do not want to enable this feature.
50 . Click *Update Setting*.
51
52 image::media/Target_Pickup_Lib2.jpg[Target_Pickup_Lib2]
53
54 Auto Override Patron Hold Events
55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56
57 In previous versions of Evergreen, you can  assign patrons a permission that
58 enables them to manually override a failed hold.   In version 2.3, when a patron
59 places a hold in the OPAC that fails, and the patron has the permission to
60 override the failed hold, a new org unit setting automatically overrides the
61 failed hold rather than requiring the patron to manually override the hold.
62
63 In version 2.3, a new org unit setting exists so that the hold override occurs
64 automatically, and the patron does not have to choose to override it. To enable
65 this org unit setting:
66
67 . Click *Admin -> Local Administration ->Library Settings Editor*.
68 . Scroll or search to find _Auto-Override Permitted Hold Blocks (Patrons)_.
69 . Set the value to _True_.
70
71 *Use Case*
72
73 A patron has placed a hold in the OPAC on a title that he has currently checked
74 out. The patron permission group contains the permission,
75 _HOLD_ITEM_CHECKED_OUT.override_. In versions prior to 2.3, a hold
76 failure message appears, and the patron must click _Submit_ to override the hold. 
77
78 In version 2.3, with the appropriate org unit setting enabled, the hold success
79 message appears automatically, and the patron is not required to take further
80 action.
81
82 Org Unit Hiding in TPAC
83 ~~~~~~~~~~~~~~~~~~~~~~~
84
85 This feature enables you to hide specific org units from patron view in the OPAC.  Org units that have not inherited this setting will display in patron-facing dropdowns.
86
87 *To enable Org Unit Hiding in TPAC:*
88
89 1) Click *Admin* -> *Local Administration* -> *Library Settings Editor* -> *Org Unit Hiding Depth*.  Note: This setting is inherited.
90
91 2) Enter a value of 0, 1, or 2 as appropriate.  Values are described in the setting description.  To view the setting description, click the *Edit* link in the first column on the *Library Settings* interface.
92
93 3) Click *Update Setting*.
94
95
96 Accepting payments with Stripe
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
99 Stripe (https://stripe.com) is a payment processing service that lets
100 sites take credit card payments without payment card information ever
101 touching the sites' own servers.
102
103 NOTE: Using Stripe as a payment processor means that clients *must*
104 have Javascript enabled in order to submit fine payments through your
105 OPAC.
106
107 Library Settings
108 ^^^^^^^^^^^^^^^^
109 The following settings need to be set at the appropriate org level for
110 sites wanting to use Stripe. These settings can be found by clicking 
111 *Admin* -> *Local Administration* -> *Library Settings Editor*
112
113
114  * "Allow Credit Card Payments" (should be 'true')
115
116  * "Enable Stripe payments" (should be 'true')
117
118  * "Stripe publishable key" (value provided by Stripe)
119
120  * "Stripe secret key" (value provided by Stripe)
121
122  * "Name default credit processor" (should be 'Stripe')
123