]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/LocalAdmin.xml
Added author statement.
[Evergreen.git] / docs / LocalAdmin.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2  
3  <chapter xmlns='http://docbook.org/ns/docbook'
4  xml:id="sample_chapter" version="5.0"
5  
6                  xmlns:xlink="http://www.w3.org/1999/xlink/"
7          xmlns:xi="http://www.w3.org/2001/XInclude"
8          xmlns:ns6="http://www.w3.org/1999/xlink"
9          xmlns:ns5="http://www.w3.org/2000/svg"
10          xmlns:ns4="http://www.w3.org/1998/Math/MathML"
11          xmlns:ns3="http://www.w3.org/1999/xhtml"
12          xmlns:ns="http://docbook.org/ns/docbook" >             
13  
14  
15 <!-- <chapter xmlns='http://docbook.org/ns/docbook'
16  xml:id="sample_chapter" version="5.0"> -->
17 <!-- The following declarations have been removed from the <chapter> tag:
18                 scratch pad for swapping namespace xmlns declarations in and out to debug warning 
19                 ("cannot add @xml.base to node set root element. Relative paths may not work.)
20
21
22 -->
23                  
24   <title>Administration</title>
25
26 <author><personname><firstname>Betty</firstname><surname>Ing</surname></personname></author>
27
28
29   <para>This chapter describes administrative features on the staff
30     client. They include:</para>
31   
32       <orderedlist>
33       <listitem>
34         <para>Operator Change</para>
35       </listitem>
36           
37       <listitem>
38         <para>Offline Transaction Management</para>
39       </listitem>         
40           
41       <listitem>
42         <para>Download Offline Patron List</para>
43                 <!--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"-->
44       </listitem>
45
46       <listitem>
47                 <para>Local System Administration</para>
48           
49 <!-- Need to find the correct syntax for <link>. Cf. Library Configuration in the Local System Admin.
50           
51         <para><link linkend="local_system_admin">Local System Administration</link></para> 
52 -->     
53       </listitem>
54         
55       <listitem>
56         <para>Server Settings</para>
57       </listitem>
58
59       <listitem>
60         <para>User Permission Editor</para>
61       </listitem>
62
63       <listitem>
64         <para>Receipt Template Editor</para>
65       </listitem>
66
67       <listitem>
68         <para>Survey Wizard</para>
69       </listitem>       
70           
71         <listitem>
72         <para>For developers (-)...</para>
73       </listitem>
74     </orderedlist>
75         
76   
77                                                                                                         <!-- Local System Administration -->
78   
79   <section>
80     <title>Local System Administration</title>
81
82     <para>The following administrative functions are available:</para>
83
84     <orderedlist>
85       <listitem>
86         <para>Workstation Configuration</para>
87       </listitem>
88
89       <listitem>
90         <para><link linkend="library_settings">Library
91         Configuration</link></para>
92       </listitem>
93
94       <listitem>
95         <para>Maintenance Reports</para>
96       </listitem>
97     </orderedlist>
98
99     <section xml:id="library_configuration">
100       <title>Library Configuration</title>
101
102       <para>The following configuration editors are available:</para>
103
104       <orderedlist>
105         <listitem>
106           <para>Closed Dates Editor</para>
107         </listitem>
108
109         <listitem>
110           <para>Copy Locations Editor</para>
111         </listitem>
112                 
113         <listitem>
114           <para>Library Settings Editor</para>
115                 </listitem>             
116                 
117         <listitem>
118           <para>Non-cataloged Types Editor</para>
119         </listitem>             
120                 
121         <listitem>
122           <para>Statistical Categories Editor</para>
123         </listitem>             
124                 
125            </orderedlist>
126
127                 
128            <section xml:id="closed_dates">
129                 <title>Closed Dates</title>             
130                 <para></para>
131            </section>
132
133            <section xml:id="copy_locations">
134                 <title>Copy Locations</title>           
135                 <para></para>
136            </section>
137
138                                                                                                         <!-- Library Settings -->                 
139            
140            <section xml:id="library_settings">
141                 <title>Library Settings</title>
142                 
143                 
144                 
145 <!-- Alert on Empty Bib Records -->             
146                 
147                         <section xml:id="alert_empty_bib_records">
148                                 <title>Alert on Empty Bib Records</title>
149                                         
150                                 <section xml:id="alert_empty_bib_records_concept">
151                                   <title>Introduction to Alert on Empty Bib Records</title>
152
153                                   <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>
154                                   
155 <!--    "last copy for a record" is coming from the GUI, but should it be "last copy of a record???" 
156 -->                               
157                                   
158                                 </section>
159
160                                 <section xml:id="alert_empty_bib_records_task">
161                                   <title>Changing the status of Alert on Empty Bib Records</title>
162
163                                   <para>To change the status of Alert on Empty Bib Records, do the following:</para>
164
165                                   <orderedlist>
166                                         <listitem>
167                                           <para>On the Local System Administration screen, click the <guilabel>Library Settings Editor</guilabel> link, which opens the Organization Unit Settings screen.</para>
168 <!--
169                                           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??? 
170 --> 
171                                         </listitem>
172                                         
173                                         <listitem>
174                                           <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>
175
176 <!--
177                                           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???   
178 -->                                       
179                                                                                 
180                                         </listitem>
181                                         
182
183                                         <listitem>
184                                           <para>On the Organization Unit Settings screen, click the <guibutton>Edit</guibutton> button beside the <guilabel>Alert on Empty Bib Records</guilabel> setting.</para>
185                                         </listitem>
186
187                                         <listitem>
188                                           <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>
189                                         </listitem>
190                                         
191 <!--
192                                 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???                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
193                                         
194 -->
195                                         <listitem>
196                                           <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>
197                                         </listitem>
198                                         
199                                         <listitem>
200                                           <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>
201                                         </listitem>                                     
202                                         
203                                         <listitem>
204                                           <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>
205                                          </listitem>                                                    
206
207                                         <listitem>
208                                           <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> 
209                                         </listitem>                                     
210                                                                 
211                                         
212                                   </orderedlist>
213                                   
214                                   <example>
215                                   <title>Example of Alert on Empty Bib Records</title>
216                                           
217                                         <para>To change Value to
218                                           False, in the <guimenu>Value</guimenu> box, select <userinput>False</userinput>.</para>
219
220                                         <para>To view the change, click the <guibutton>Update Setting</guibutton> button.</para>                                          
221                                    </example>
222                                   
223                                 </section>
224
225                                 <section xml:id="alert_empty_bib_records__ref">                                                                                                                                                                                                               
226                                   <title>References for the Alert on Empty Bib Records</title>
227                                   
228                                   <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
229         <!--                            
230                                   <itemizedlist>
231                                         <listitem>
232                                           <para><link linkend="permissions">http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</link></para>
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>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
294                                 
295                                 </section>                              
296                                 
297                                         
298                         </section>
299
300
301
302 <!-- Change Reshelving Status Interval -->                      
303            
304                         <section xml:id="reshelving">
305                                 <title>Change Reshelving Status Interval</title>
306
307                                 <section xml:id="reshelving_concept">
308                                   <title>Introduction to Change Reshelving Status Interval</title>
309
310                                         <para>What kind of preamble do we need here???</para>
311
312                                 </section>
313 <!--
314                                 <section xml:id="reshelving_task">
315                                   <title>Change Reshelving Status Interval</title>
316
317                                   <para>To change the reshelving status interval, the following fields are available:</para>
318                                         <segmentedlist>
319                                         <title>Fields in the Edit Setting pop-up window</title>
320                                         <?dbhtml list-presentation="table"?>
321                                         <segtitle>Context</segtitle>
322                                         <segtitle>Value</segtitle>
323                                         <seglistitem><seg>System</seg><seg>Status (True or False)</seg></seglistitem>
324                                         <seglistitem><seg>Branch</seg><seg>Status (True or False)</seg></seglistitem>                                   
325                                         </segmentedlist>
326                                   </para>
327                                  </section>
328 -->                              
329                                  <section xml:id="change_reshelving_status_interval_task">
330                                   <title>Change Reshelving Status Interval</title>
331
332                                   <para>To change the reshelving status interval, do the following:</para>
333
334                                   <orderedlist>
335                                         <listitem>
336                                           <para>On the Local System Administration screen, click the
337                                           <guilabel>Library Settings Editor</guilabel> link.</para>
338                                         </listitem>
339
340                                         <listitem>
341                                           <para>On the Organization Unit Settings screen, find the setting <guilabel>Change reshelving status
342                                           interval</guilabel>, and click
343                                           <guibutton>Edit</guibutton>.</para>
344                                         </listitem>
345
346                                         <listitem>
347                                           <para>In the Edit Setting pop-up window, select a location from the
348                                           <guimenu>Context</guimenu> box.</para>
349                                         </listitem>
350
351                                         <listitem>
352                                           <para>In the <guilabel>Value</guilabel> box, enter a value in
353                                           seconds, hours, or days. The value cannot be zero; however, a value of 1 second is valid.</para>
354         <!--    
355                  What are the default units when none are entered with the value???
356         -->     
357                                         </listitem>
358                                         
359                                         <listitem>
360                                           <para>Click the <guibutton>Update Setting</guibutton> button.</para>
361                                         </listitem>                                     
362                                         
363                                         <listitem>
364                                           <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>
365                                          </listitem>                                                    
366
367                                         <listitem>
368                                           <para>To delete both Context and Value for the reshelving status interval, click on <guibutton>Delete Setting</guibutton>.</para> 
369                                         </listitem>                                     
370                                                                          
371                                   </orderedlist>
372                                                   
373                                   <example>
374                                   <title>Example of Change Reshelving Status Interval</title>                     
375                                   
376                                           <para>For example, to change the reshelving status interval to
377                                           four hours, enter <userinput>4 hours</userinput> in the
378                                           <guilabel>Value</guilabel> box.</para>                          
379                                   </example>                      
380                                                                          
381                                 </section>
382                                 
383                                 <section xml:id="reshelving_ref">
384                                   <title>References for Change Reshelving Status Interval</title>
385                                                                   
386                                   <para>http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</para>
387                                   
388         <!--                              
389                                   <itemizedlist>
390                                         <listitem>
391                                           <para><link linkend="permissions">http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list</link></para>
392                                         
393                                          
394                                          <xref xlink:href="http://open-ils.org/dokuwiki/doku.php?id=evergreen-user:permission_list"/>
395                                          
396                                         </listitem>
397                                   </itemizedlist>
398         -->                       
399                                   
400                                 </section>
401
402                                  <section> 
403                                         <title>Notes for Change Reshelving Status Interval</title>
404                                   
405                                     <note>
406                                           <para>The reshelving status interval is not inherited from the
407                                   parent organizational unit at run time. The default value is 24
408                                   hours??? and can be changed through the <guimenu>Local System
409                                   Administration</guimenu> menu.</para>
410                                 
411                                         <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>                             
412                                   
413                                    </note>
414                                 </section>  
415                                   
416                         </section>
417
418
419                         
420                                                           
421                         <section xml:id="default_item_price">
422                                 <title>Default Item Price</title>
423                                 <para></para>
424                         </section>      
425
426                         <section xml:id="default_locale">
427                                 <title>Default Locale</title>
428                                 <para></para>
429                         </section>      
430                         
431                         <section xml:id="no_auto_deletion_empty_bib_records">
432                                 <title>Do not Automatically Delete Empty Bib Records</title>
433                                 <para></para>
434                         </section>                              
435                         
436                         <section xml:id="holds_expire_alert_interval">
437                                 <title>Holds: Expire Alert Interval</title>
438                                 <para></para>
439                         </section>                              
440                         
441                         <section xml:id="holds_expire_interval">
442                                 <title>Holds: Expire Interval</title>
443                                 <para></para>
444                         </section>                              
445         
446                         <section xml:id="holds_hard">
447                                 <title>Holds: Hard Boundary</title>
448                                 <para></para>
449                         </section>
450                         
451                         <section xml:id="holds_soft">
452                                 <title>Holds: Soft Boundary</title>
453                                 <para></para>
454                         </section>
455                         
456                         <section xml:id="lost_materials_proc_fee">
457                                 <title>Lost Materials Processing Fee</title>
458                                 <para></para>
459                         </section>      
460
461                         <section xml:id="max_prev_checkouts">
462                                 <title>Maximum Previous Checkouts Displayed</title>
463                                 <para></para>
464                         </section>                              
465                         
466                         <section xml:id="OPAC_inactivity_timeout">
467                                 <title>OPAC Inactivity Timeout</title>
468                                 <para></para>
469                         </section>                              
470                         
471                         <section xml:id="patron_barcode">
472                                 <title>Patron Barcode Format</title>
473                                 <para></para>
474                         </section>
475
476                         <section xml:id="patron_login">
477                                 <title>Selfcheck: Patron Login Timeout (in seconds)</title>
478                                 <para></para>
479                         </section>      
480
481                         <section xml:id="pop_up_alert">
482                                 <title>Selfcheck: Pop-up Alert for Errors</title>
483                                 <para></para>
484                         </section>      
485
486                         <section xml:id="patron_password">
487                                 <title>Selfcheck: Require Patron Password</title>
488                                 <para></para>
489                         </section>      
490
491                         <section xml:id="email_addr_for_patron_notices">
492                                 <title>Sending Email Address for Patron Notices</title>
493                                 <para></para>
494                         </section>      
495
496                         <section xml:id="staff_login_inactivity_timeout">
497                                 <title>Staff Login Inactivity Timeout (in seconds)</title>
498                                 <para></para>
499                         </section>      
500
501                         <section xml:id="void_overdue_fines">
502                                 <title>Void Overdue Fines When Items are Marked Lost</title>
503                                 <para></para>
504                         </section>      
505                                 
506       </section>
507     </section>
508   </section>
509 </chapter>