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