]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/LocalAdmin.xml
git-svn-id: svn://svn.open-ils.org/ILS/trunk@13018 dcc99617-32d9-48b4-a31d-7c20da2025e4
[Evergreen.git] / docs / LocalAdmin.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2  
3  <chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
4  
5            xmlns:xlink="http://www.w3.org/1999/xlink/"
6          xmlns:xi="http://www.w3.org/2001/XInclude"
7          xmlns:ns6="http://www.w3.org/1999/xlink"
8          xmlns:ns5="http://www.w3.org/2000/svg"
9          xmlns:ns4="http://www.w3.org/1998/Math/MathML"
10          xmlns:ns3="http://www.w3.org/1999/xhtml"
11           >             
12  
13
14                  
15   <title>Local Administration</title>
16
17 <!-- Betty Ing 030509 -->
18
19
20   <para>This chapter describes administrative features on the staff
21     client. They include:</para>
22   
23       <orderedlist>
24       <listitem>
25         <para>Operator Change</para>
26       </listitem>
27           
28       <listitem>
29         <para>Offline Transaction Management</para>
30       </listitem>         
31           
32       <listitem>
33         <para>Download Offline Patron List</para>
34                 <!--Why is there a download command among editing features? It is generating an Alert in a pop-up window with the following message: "There was a problem with the download. The server returned a status of 404:Not Found"-->
35       </listitem>
36
37       <listitem>
38                 <para>Local System Administration</para>
39           
40 <!-- Need to find the correct syntax for <link>. Cf. Library Configuration in the Local System Admin.
41           
42         <para><link linkend="local_system_admin">Local System Administration</link></para> 
43 -->     
44       </listitem>
45         
46       <listitem>
47         <para>Server Settings</para>
48       </listitem>
49
50       <listitem>
51         <para>User Permission Editor</para>
52       </listitem>
53
54       <listitem>
55         <para>Receipt Template Editor</para>
56       </listitem>
57
58       <listitem>
59         <para>Survey Wizard</para>
60       </listitem>       
61           
62         <listitem>
63         <para>For developers (-)...</para>
64       </listitem>
65     </orderedlist>
66         
67   
68                                                                                                         <!-- Local System Administration -->
69   
70   <section>
71     <title>Local System Administration</title>
72
73     <para>The following administrative functions are available:</para>
74
75     <orderedlist>
76       <listitem>
77         <para>Workstation Configuration</para>
78       </listitem>
79
80       <listitem>
81         <para><link linkend="library_settings">Library
82         Configuration</link></para>
83       </listitem>
84
85       <listitem>
86         <para>Maintenance Reports</para>
87       </listitem>
88     </orderedlist>
89
90     <section xml:id="library_configuration">
91       <title>Library Configuration</title>
92
93       <para>The following configuration editors are available:</para>
94
95       <orderedlist>
96         <listitem>
97           <para>Closed Dates Editor</para>
98         </listitem>
99
100         <listitem>
101           <para>Copy Locations Editor</para>
102         </listitem>
103                 
104         <listitem>
105           <para>Library Settings Editor</para>
106                 </listitem>             
107                 
108         <listitem>
109           <para>Non-cataloged Types Editor</para>
110         </listitem>             
111                 
112         <listitem>
113           <para>Statistical Categories Editor</para>
114         </listitem>             
115                 
116            </orderedlist>
117
118                 
119            <section xml:id="closed_dates">
120                 <title>Closed Dates</title>             
121                 <para></para>
122            </section>
123
124            <section xml:id="copy_locations">
125                 <title>Copy Locations</title>           
126                 <para></para>
127            </section>
128
129                                                                                                         <!-- Library Settings -->                 
130            
131            <section xml:id="library_settings">
132                 <title>Library Settings</title>
133                 
134                 
135                 
136 <!-- Alert on Empty Bib Records -->             
137                 
138                         <section xml:id="alert_empty_bib_records">
139                                 <title>Alert on Empty Bib Records</title>
140                                         
141                                 <section xml:id="alert_empty_bib_records_concept">
142                                   <title>Introduction to Alert on Empty Bib Records</title>
143
144                                   <para>This setting is used to alert staff when the last copy for a record is being deleted. The setting consists of two fields: Context and Value. The Context field refers to either all the branches of a system or a specific branch within a system, with a default of??? The Value field refers to the status of Alert on Empty Bib Records, which can be either True or False, with a default of??? </para>
145                                   
146 <!--    "last copy for a record" is coming from the GUI, but should it be "last copy of a record???" 
147 -->                               
148                                   
149                                 </section>
150
151                                 <section xml:id="alert_empty_bib_records_task">
152                                   <title>Changing the status of Alert on Empty Bib Records</title>
153
154                                   <para>To change the status of Alert on Empty Bib Records, do the following:</para>
155
156                                   <orderedlist>
157                                         <listitem>
158                                           <para>On the Local System Administration screen, click the <guilabel>Library Settings Editor</guilabel> link, which opens the Organization Unit Settings screen.</para>
159 <!--
160                                           Are we keeping these link and screen names??? Will there be any confusion for library staff who might be expecting a Library Settings screen, rather than the Organization Unit Setting screen, which is more accurate from the developer's point of view??? 
161 --> 
162                                         </listitem>
163                                         
164                                         <listitem>
165                                           <para>On the Organization Unit Settings screen, click the <guibutton>Context Location</guibutton> arrow to see more options. In the Context Location box, select a location.</para>
166
167 <!--
168                                           Is this the location that will be passed to all the Organization Unit settings??? If so, why is there still a drop-down combo box for Context selection???   
169 -->                                       
170                                                                                 
171                                         </listitem>
172                                         
173
174                                         <listitem>
175                                           <para>On the Organization Unit Settings screen, click the <guibutton>Edit</guibutton> button beside the <guilabel>Alert on Empty Bib Records</guilabel> setting.</para>
176                                         </listitem>
177
178                                         <listitem>
179                                           <para>In the Edit Setting pop-up window, click the <guimenu>Context</guimenu> arrow for more options. In the Context box, select a location.</para>
180                                         </listitem>
181                                         
182 <!--
183                                 What is the effect of te Context Location not being inherited from the parent org unit at run time??? Does this mean that the user is free to select any location and change the corresponding Value??? As a test, I tried changing the Context in the Edit Setting pop-up window for Alert on Empty Bib Records, and I was not able to see the new Value after clicking the Update Setting button.  Why???                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
184                                         
185 -->
186                                         <listitem>
187                                           <para>In the Edit Setting pop-up window, click the <guilabel>Value</guilabel> arrow for more options. In the Value box, select a status.</para>
188                                         </listitem>
189                                         
190                                         <listitem>
191                                           <para>To view the new data for Context and Value, in the Edit Setting pop-up window, click the <guibutton>Update Setting</guibutton> button.</para>
192                                         </listitem>                                     
193                                         
194                                         <listitem>
195                                           <para>On the Organization Unit Settings screen, on the Alert on Empty Bib Records row, you see the current selected location under the Context column and the current selected status under the Value column.</para>
196                                          </listitem>                                                    
197
198                                         <listitem>
199                                           <para>To delete the data for both Context and Value on the Alert on Empty Bib Records row, click the <guibutton>Delete Setting</guibutton> button.</para> 
200                                         </listitem>                                     
201                                                                 
202                                         
203                                   </orderedlist>
204                                   
205                                   <example>
206                                   <title>Example of Alert on Empty Bib Records</title>
207                                           
208                                         <para>To change Value to
209                                           False, in the <guimenu>Value</guimenu> box, select <userinput>False</userinput>.</para>
210
211                                         <para>To view the change, click the <guibutton>Update Setting</guibutton> button.</para>                                          
212                                    </example>
213                                   
214                                 </section>
215
216                                 <section xml:id="alert_empty_bib_records__ref">                                                                                                                                                                                                               
217                                   <title>References for the Alert on Empty Bib Records</title>
218                                   
219 <para>
220
221 <link xlink:href="http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list">User Permissions in Evergreen</link>
222 </para>
223         <!--                            
224                                   <itemizedlist>
225                                         <listitem>
226
227 <para>
228  .
229
230
231 </para>
232
233                                         </listitem>
234
235                                   </itemizedlist>
236         -->                       
237                                 </section>
238                                 
239                         </section>
240
241
242 <!-- Credit Card Payments -->                           
243                 
244                         <section xml:id="credit_card_payments">
245                                 <title>Allow Credit Card Payments</title>
246                                 
247                                 <section xml:id="credit_card_payments_concept">
248                                   <title>Introduction to Allow Credit Card Payments</title>
249
250                                   <para>If enabled, patrons will be able to pay fines accrued at this location via credit card. The default value is True??? It can be changed through the <guimenu>Local System
251                                   Administration</guimenu> menu.</para>
252                                 </section>
253
254                                 <section xml:id="credit_card_payments_task">
255                                   <title>Allow Credit Card Payments</title>
256
257                                   <para>To allow credit card payments, do the following:</para>
258
259                                   <orderedlist>
260                                         <listitem>
261                                           <para>On the Local System Administration screen, click the
262                                           <guilabel>Library Settings Editor</guilabel> link.</para>
263                                         </listitem>
264
265                                         <listitem>
266                                           <para>On the Organization Unit Settings screen, click the <guibutton>Edit</guibutton> button beside the <guilabel>Allow Credit Card Payments</guilabel> setting.</para>
267                                         </listitem>                                     
268                                                 
269                                         <listitem>
270                                           <para>In the Edit Setting pop-up window, select a location from the
271                                           <guimenu>Context</guimenu> box.</para>
272                                         </listitem>
273
274                                         <listitem>
275                                           <para>In the <guilabel>Value</guilabel> box, select a value.</para>
276
277                                         </listitem>
278                                   </orderedlist>
279                                   
280                                   <example>
281                                   <title>Example of Allow Credit Card Payments</title>                    
282                                   
283                                           <para>To change the credit card payment status to
284                                           false, select <userinput>False</userinput> from the
285                                           <guilabel>Value</guilabel> list.</para>                                 
286                                   </example>                              
287                                   
288                                 </section>
289
290                                 <section xml:id="credit_card_payments_ref">
291                                   <title>References for Credit Card Payments</title>
292
293                                           <para>
294
295 <ulink url="http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list">
296 User Permissions in Evergreen</ulink></para>
297                                 
298                                 </section>                              
299                                 
300                                         
301                         </section>
302
303
304
305 <!-- Change Reshelving Status Interval -->                      
306            
307                         <section xml:id="reshelving">
308                                 <title>Change Reshelving Status Interval</title>
309
310                                 <section xml:id="reshelving_concept">
311                                   <title>Introduction to Change Reshelving Status Interval</title>
312
313                                         <para>What kind of preamble do we need here???</para>
314
315                                 </section>
316 <!--
317                                 <section xml:id="reshelving_task">
318                                   <title>Change Reshelving Status Interval</title>
319
320                                   <para>To change the reshelving status interval, the following fields are available:</para>
321                                         <segmentedlist>
322                                         <title>Fields in the Edit Setting pop-up window</title>
323                                         <?dbhtml list-presentation="table"?>
324                                         <segtitle>Context</segtitle>
325                                         <segtitle>Value</segtitle>
326                                         <seglistitem><seg>System</seg><seg>Status (True or False)</seg></seglistitem>
327                                         <seglistitem><seg>Branch</seg><seg>Status (True or False)</seg></seglistitem>                                   
328                                         </segmentedlist>
329                                   </para>
330                                  </section>
331 -->                              
332                                  <section xml:id="change_reshelving_status_interval_task">
333                                   <title>Change Reshelving Status Interval</title>
334
335                                   <para>To change the reshelving status interval, do the following:</para>
336
337                                   <orderedlist>
338                                         <listitem>
339                                           <para>On the Local System Administration screen, click the
340                                           <guilabel>Library Settings Editor</guilabel> link.</para>
341                                         </listitem>
342
343                                         <listitem>
344                                           <para>On the Organization Unit Settings screen, find the setting <guilabel>Change reshelving status
345                                           interval</guilabel>, and click
346                                           <guibutton>Edit</guibutton>.</para>
347                                         </listitem>
348
349                                         <listitem>
350                                           <para>In the Edit Setting pop-up window, select a location from the
351                                           <guimenu>Context</guimenu> box.</para>
352                                         </listitem>
353
354                                         <listitem>
355                                           <para>In the <guilabel>Value</guilabel> box, enter a value in
356                                           seconds, hours, or days. The value cannot be zero; however, a value of 1 second is valid.</para>
357         <!--    
358                  What are the default units when none are entered with the value???
359         -->     
360                                         </listitem>
361                                         
362                                         <listitem>
363                                           <para>Click the <guibutton>Update Setting</guibutton> button.</para>
364                                         </listitem>                                     
365                                         
366                                         <listitem>
367                                           <para>On the Organization Unit Settings screen, you can see the selected organization unit under the Context column and the reshelving status interval  under the Value column.</para>
368                                          </listitem>                                                    
369
370                                         <listitem>
371                                           <para>To delete both Context and Value for the reshelving status interval, click on <guibutton>Delete Setting</guibutton>.</para> 
372                                         </listitem>                                     
373                                                                          
374                                   </orderedlist>
375                                                   
376                                   <example>
377                                   <title>Example of Change Reshelving Status Interval</title>                     
378                                   
379                                           <para>For example, to change the reshelving status interval to
380                                           four hours, enter <userinput>4 hours</userinput> in the
381                                           <guilabel>Value</guilabel> box.</para>                          
382                                   </example>                      
383                                                                          
384                                 </section>
385                                 
386                                 <section xml:id="reshelving_ref">
387                                   <title>References for Change Reshelving Status Interval</title>
388                                                                   
389                                   <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
390                                   
391         <!--                              
392                                   <itemizedlist>
393                                         <listitem>
394                                           <para><link linkend="permissions">http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</link></para>
395                                         
396                                          
397                                          <xref xlink:href="http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list"/>
398                                          
399                                         </listitem>
400                                   </itemizedlist>
401         -->                       
402                                   
403                                 </section>
404
405                                  <section> 
406                                         <title>Notes for Change Reshelving Status Interval</title>
407                                   
408                                     <note>
409                                           <para>The reshelving status interval is not inherited from the
410                                   parent organizational unit at run time. The default value is 24
411                                   hours??? and can be changed through the <guimenu>Local System
412                                   Administration</guimenu> menu.</para>
413                                 
414                                         <para>  Permissions for organization unit settings are not automatically created at install time, which means the permission will have to be created before it can be applied.</para>                             
415                                   
416                                    </note>
417                                 </section>  
418                                   
419                         </section>
420
421
422                         
423                                                           
424                         <section xml:id="default_item_price">
425                                 <title>Default Item Price</title>
426                                 <para></para>
427                         </section>      
428
429                         <section xml:id="default_locale">
430                                 <title>Default Locale</title>
431                                 <para></para>
432                         </section>      
433                         
434                         <section xml:id="no_auto_deletion_empty_bib_records">
435                                 <title>Do not Automatically Delete Empty Bib Records</title>
436                                 <para></para>
437                         </section>                              
438                         
439                         <section xml:id="holds_expire_alert_interval">
440                                 <title>Holds: Expire Alert Interval</title>
441                                 <para></para>
442                         </section>                              
443                         
444                         <section xml:id="holds_expire_interval">
445                                 <title>Holds: Expire Interval</title>
446                                 <para></para>
447                         </section>                              
448         
449                         <section xml:id="holds_hard">
450                                 <title>Holds: Hard Boundary</title>
451                                 <para></para>
452                         </section>
453                         
454                         <section xml:id="holds_soft">
455                                 <title>Holds: Soft Boundary</title>
456                                 <para></para>
457                         </section>
458                         
459                         <section xml:id="lost_materials_proc_fee">
460                                 <title>Lost Materials Processing Fee</title>
461                                 <para></para>
462                         </section>      
463
464                         <section xml:id="max_prev_checkouts">
465                                 <title>Maximum Previous Checkouts Displayed</title>
466                                 <para></para>
467                         </section>                              
468                         
469                         <section xml:id="OPAC_inactivity_timeout">
470                                 <title>OPAC Inactivity Timeout</title>
471                                 <para></para>
472                         </section>                              
473                         
474                         <section xml:id="patron_barcode">
475                                 <title>Patron Barcode Format</title>
476                                 <para></para>
477                         </section>
478
479                         <section xml:id="patron_login">
480                                 <title>Selfcheck: Patron Login Timeout (in seconds)</title>
481                                 <para></para>
482                         </section>      
483
484                         <section xml:id="pop_up_alert">
485                                 <title>Selfcheck: Pop-up Alert for Errors</title>
486                                 <para></para>
487                         </section>      
488
489                         <section xml:id="patron_password">
490                                 <title>Selfcheck: Require Patron Password</title>
491                                 <para></para>
492                         </section>      
493
494                         <section xml:id="email_addr_for_patron_notices">
495                                 <title>Sending Email Address for Patron Notices</title>
496                                 <para></para>
497                         </section>      
498
499                         <section xml:id="staff_login_inactivity_timeout">
500                                 <title>Staff Login Inactivity Timeout (in seconds)</title>
501                                 <para></para>
502                         </section>      
503
504                         <section xml:id="void_overdue_fines">
505                                 <title>Void Overdue Fines When Items are Marked Lost</title>
506                                 <para></para>
507                         </section>      
508                                 
509       </section>
510     </section>
511   </section>
512 </chapter>