Add index terms.
[working/Evergreen.git] / 1.6 / stafftasks / staffclient.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="usingstaffclient" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4    <info>\r
5 \r
6       <title>Using the Staff Client</title>\r
7 \r
8    </info>\r
9 \r
10    <section>\r
11       <info>\r
12          <title>Logging in to Evergreen</title><indexterm><primary>staff client</primary><secondary>logging into</secondary></indexterm>\r
13       </info>\r
14 \r
15       <para>To log in you must first install the Evergreen Staff Client, available for download from\r
16          the Evergreen site at <link\r
17             xlink:href="http://downloads.open-ils.org/"\r
18             >http://downloads.open-ils.org/</link>.</para>\r
19 \r
20       <para>Each staff member can have their own username and password, or generic logins can be\r
21          used.</para>\r
22       <para>\r
23 \r
24 \r
25 \r
26          <mediaobject xml:id="staffclient-login">\r
27             <alt>screenshot of staff client login</alt>\r
28             <imageobject>\r
29                <imagedata scalefit="0" fileref="../media/staffclient-1.png"/>\r
30             </imageobject>\r
31 \r
32          </mediaobject>\r
33       </para>\r
34 \r
35 \r
36 \r
37 \r
38       <para>\r
39          <inlinemediaobject>\r
40             <imageobject>\r
41                <imagedata scalefit="0" fileref="../media/1.png"/>\r
42             </imageobject>\r
43          </inlinemediaobject> Enter <guilabel>Username</guilabel> and <guilabel>Password</guilabel>\r
44          for your staff account, then click <guibutton>Login</guibutton>. Under normal circumstances\r
45          this is all that is required to login. </para>\r
46 \r
47 \r
48       <para>\r
49          <inlinemediaobject>\r
50             <imageobject>\r
51                <imagedata scalefit="0" fileref="../media/2.png"/>\r
52             </imageobject>\r
53          </inlinemediaobject> If the staff client can connect to Evergreen both\r
54             <guilabel>Status</guilabel> and <guilabel>Version</guilabel> display a green\r
55             <emphasis>200:OK</emphasis> message. If not, ensure the hostname is\r
56             correctly entered and click <guibutton>Re-Test\r
57             Server</guibutton>. If the error message persists make sure your are connected to the\r
58          internet.</para>\r
59 \r
60 \r
61       <para>\r
62          <inlinemediaobject>\r
63             <imageobject>\r
64                <imagedata scalefit="0" fileref="../media/3.png"/>\r
65             </imageobject>\r
66          </inlinemediaobject>\r
67          <guilabel>Locale</guilabel> sets the language preferences for the staff client.</para>\r
68 \r
69       <para>\r
70          <inlinemediaobject>\r
71             <imageobject>\r
72                <imagedata  scalefit="0" fileref="../media/4.png"/>\r
73             </imageobject>\r
74          </inlinemediaobject>\r
75          <guilabel>Workstation</guilabel> identifies your physical computer location. Workstation registration is done by a Local System\r
76          Administrator when staff clients are first installed. </para>\r
77 \r
78       <para>\r
79          <inlinemediaobject>\r
80             <imageobject>\r
81                <imagedata scalefit="0" fileref="../media/5.png"/>\r
82             </imageobject>\r
83          </inlinemediaobject> If your connection to Evergreen is lost during open hours, click\r
84             <guibutton>Standalone Interface</guibutton> to continue with check out and patron\r
85          registration functions until the connection is restored. </para>\r
86 \r
87       <para>\r
88          <inlinemediaobject>\r
89             <imageobject>\r
90                <imagedata scalefit="0" fileref="../media/6.png"/>\r
91             </imageobject>\r
92          </inlinemediaobject>\r
93          <guilabel>Debug Options</guilabel> are for advanced troubleshooting and can be ignored in\r
94          normal use. </para>\r
95 \r
96       <para>\r
97          <inlinemediaobject>\r
98             <imageobject>\r
99                <imagedata scalefit="0" fileref="../media/7.png"/>\r
100             </imageobject>\r
101          </inlinemediaobject> Click <guibutton>Clear Cache</guibutton> to remove the staff client's\r
102          locally cached files. This may be required to see recent changes to administrative settings.</para>\r
103 \r
104 \r
105 \r
106 \r
107    </section>\r
108    <section xml:id="staffclient-navigating" >\r
109       <info>\r
110          <title>Navigation</title><indexterm><primary>staff client</primary><secondary>navigating</secondary></indexterm>\r
111       </info>\r
112 \r
113       <simplesect>\r
114          <info>\r
115             <title>Tabs</title>\r
116          </info>\r
117          <para><application>Evergreen</application> uses tabs to display functions. Tabs allow all\r
118             software functionality to be open in one window. You can have up to 9 tabs open at once\r
119             and you can have more than one tab of a single function open at the same time. You\r
120             simply move through the tabs to perform your work.</para>\r
121 \r
122          <itemizedlist>\r
123             <title>Keyboard shortcuts for working with tabs:</title>\r
124             <listitem>\r
125                <para><keycombo>\r
126                      <keycap>Ctrl</keycap>\r
127                      <keycap>T</keycap>\r
128                   </keycombo> new tab</para>\r
129             </listitem>\r
130             <listitem>\r
131                <para><keycombo>\r
132                      <keycap>Ctrl</keycap>\r
133                      <keycap>W</keycap>\r
134                   </keycombo>   close tab</para>\r
135             </listitem>\r
136             <listitem>\r
137                <para><keycombo>\r
138                      <keycap>Ctrl</keycap>\r
139                      <keycap>Shift</keycap>\r
140                      <keycap>W</keycap>\r
141                   </keycombo>   close all tabs</para>\r
142             </listitem>\r
143             <listitem>\r
144                <para><keycombo>\r
145                      <keycap>Ctrl</keycap>\r
146                      <keycap>Tab</keycap>\r
147                   </keycombo>   tabs forward through open tabs</para>\r
148             </listitem>\r
149             <listitem>\r
150                <para><keycombo>\r
151                      <keycap>Ctrl</keycap>\r
152                      <keycap>Shift</keycap>\r
153                      <keycap>Tab</keycap>\r
154                   </keycombo>   tabs backward through open tabs</para>\r
155             </listitem>\r
156          </itemizedlist>\r
157          <informalfigure>\r
158             <para>In the example below, the <guilabel>MARC Template</guilabel> tab is active. Click\r
159                on any open tab to bring that screen to the front. You can also use <keycombo>\r
160                   <keycap>Ctrl</keycap>\r
161                   <keycap>Tab</keycap>\r
162                </keycombo> to move to the required tab</para>\r
163 \r
164             <para><mediaobject>\r
165                <alt>staff client tabs</alt>\r
166                <imageobject>\r
167                   <imagedata scalefit="0" fileref="../media/staffclient-2.png"/>\r
168                </imageobject>\r
169             </mediaobject></para>\r
170          </informalfigure>\r
171          <informalfigure>\r
172             <para>Now the <guilabel>Check Out</guilabel> tab is the active screen.</para>\r
173             <para><mediaobject>\r
174                <alt>staff client tabs</alt>\r
175                <imageobject>\r
176                   <imagedata scalefit="0" fileref="../media/staffclient-3.png"/>\r
177                </imageobject>\r
178             </mediaobject></para>\r
179          </informalfigure>\r
180          <para>Once you are in the selected tab, you can use the drop down menus or keyboard\r
181             shortcuts to perform required functions. Menu functions and corresponding keyboard\r
182             shortcuts will be demonstrated throughout this manual.</para>\r
183       </simplesect>\r
184       <simplesect>\r
185          <info>\r
186             <title>Keyboard Shortcuts</title><indexterm><primary>staff client</primary><secondary>keyboard shortcuts</secondary></indexterm>\r
187          </info>\r
188          <para>Most menu items have keyboard shorcuts that can greatly increase efficiency. Below is\r
189             a selected list of commonly used shortcut keys:</para>\r
190          <informaltable>\r
191             <?dbfo keep-together="always" ?>\r
192             <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
193                <colspec colnum="1" colname="key" colwidth="1.0*"/>\r
194                <colspec colnum="2" colname="function" colwidth="3.0*"/>\r
195                <thead>\r
196                   <row>\r
197                      <entry>Key</entry>\r
198                      <entry>Function</entry>\r
199                   </row>\r
200                </thead>\r
201                <tbody>\r
202                   <row>\r
203                      <entry>\r
204                         <keycap>F1</keycap>\r
205                      </entry>\r
206                      <entry>Checkout, or retrieve patron record by barcode</entry>\r
207                   </row>\r
208                   <row>\r
209                      <entry>\r
210                         <keycap>F2</keycap>\r
211                      </entry>\r
212                      <entry>Checkin</entry>\r
213                   </row>\r
214                   <row>\r
215                      <entry>\r
216                         <keycap>F3</keycap>\r
217                      </entry>\r
218                      <entry>Catalogue search</entry>\r
219                   </row>\r
220 \r
221                   <row>\r
222                      <entry>\r
223                         <keycap>F4</keycap>\r
224                      </entry>\r
225                      <entry>Patron search</entry>\r
226                   </row>\r
227 \r
228                   <row>\r
229                      <entry>\r
230                         <keycap>F5</keycap>\r
231                      </entry>\r
232                      <entry>Retrieve copy by barcode</entry>\r
233                   </row>\r
234 \r
235                   <row>\r
236                      <entry>\r
237                         <keycap>F6</keycap>\r
238                      </entry>\r
239                      <entry>Record in house use</entry>\r
240                   </row>\r
241 \r
242                   <row>\r
243                      <entry>\r
244                         <keycap>F8</keycap>\r
245                      </entry>\r
246                      <entry>Retreive last patron</entry>\r
247                   </row>\r
248 \r
249                   <row>\r
250                      <entry>\r
251                         <keycap>F9</keycap>\r
252                      </entry>\r
253                      <entry>Re-print the last receipt</entry>\r
254                   </row>\r
255 \r
256                   <row>\r
257                      <entry>\r
258                         <keycombo>\r
259                            <keycap>Shift</keycap>\r
260                            <keycap>F1</keycap>\r
261                         </keycombo>\r
262                      </entry>\r
263                      <entry>Register new patron</entry>\r
264                   </row>\r
265 \r
266                   <row>\r
267                      <entry>\r
268                         <keycombo>\r
269                            <keycap>Shift</keycap>\r
270                            <keycap>F2</keycap>\r
271                         </keycombo>\r
272                      </entry>\r
273                      <entry>Capture holds</entry>\r
274                   </row>\r
275 \r
276                   <row>\r
277                      <entry>\r
278                         <keycombo>\r
279                            <keycap>Shift</keycap>\r
280                            <keycap>F3</keycap>\r
281                         </keycombo>\r
282                      </entry>\r
283                      <entry>Retrieve record by TCN</entry>\r
284                   </row>\r
285 \r
286                   <row>\r
287                      <entry>\r
288                         <keycombo>\r
289                            <keycap>Shift</keycap>\r
290                            <keycap>F8</keycap>\r
291                         </keycombo>\r
292                      </entry>\r
293                      <entry>Retreive last patron</entry>\r
294                   </row>\r
295 \r
296                   <row>\r
297                      <entry>\r
298                         <keycombo>\r
299                            <keycap>Ctrl</keycap>\r
300                            <keycap>T</keycap>\r
301                         </keycombo>\r
302                      </entry>\r
303                      <entry>Open new tab</entry>\r
304                   </row>\r
305 \r
306                   <row>\r
307                      <entry>\r
308                         <keycombo>\r
309                            <keycap>Ctrl</keycap>\r
310                            <keycap>W</keycap>\r
311                         </keycombo>\r
312                      </entry>\r
313                      <entry>Close current tab</entry>\r
314                   </row>\r
315 \r
316                   <row>\r
317                      <entry>\r
318                         <keycombo>\r
319                            <keycap>Ctrl</keycap>\r
320                            <keycap>Tab</keycap>\r
321                         </keycombo>\r
322                      </entry>\r
323                      <entry>Move forward through tabs</entry>\r
324                   </row>\r
325 \r
326                   <row>\r
327                      <entry>\r
328                         <keycombo>\r
329                            <keycap>Ctrl</keycap>\r
330                            <keycap>Shift</keycap>\r
331                            <keycap>Tab</keycap>\r
332                         </keycombo>\r
333                      </entry>\r
334                      <entry>Move back through tabs</entry>\r
335                   </row>\r
336                   <row>\r
337                      <entry>\r
338                         <keycombo>\r
339                            <keycap>Ctrl</keycap>\r
340                            <keycap>C</keycap>\r
341                         </keycombo>\r
342                      </entry>\r
343                      <entry>Copy</entry>\r
344                   </row>\r
345 \r
346                   <row>\r
347                      <entry>\r
348                         <keycombo>\r
349                            <keycap>Ctrl</keycap>\r
350                            <keycap>V</keycap>\r
351                         </keycombo>\r
352                      </entry>\r
353                      <entry>Paste</entry>\r
354                   </row>\r
355                </tbody>\r
356             </tgroup>\r
357          </informaltable>\r
358       </simplesect>\r
359       <simplesect>\r
360          <info>\r
361             <title>Copy/Paste</title><indexterm><primary>staff client</primary><secondary>copy/paste</secondary></indexterm>\r
362          </info>\r
363 \r
364          <para>There are several methods of copying and pasting text in Evergreen, depending on\r
365             where you are in the staff client and the type of information you are copying</para>\r
366          <orderedlist>\r
367             <listitem>\r
368                <informalfigure>\r
369                   <formalpara>\r
370                      <title>Underlined blue text</title>\r
371                      <para>Clicking on any of the blue links in the\r
372                            <application>Evergreen</application> client copies the data to the\r
373                         computer clipboard (left and right click work the same way for these links).\r
374                         To paste into another location, use <keycombo>\r
375                            <keycap>Ctrl</keycap>\r
376                            <keycap>V</keycap>\r
377                         </keycombo>.</para>\r
378                   </formalpara>\r
379                   <para>\r
380                      <mediaobject>\r
381                         <alt>copy/paste methods</alt>\r
382                         <imageobject>\r
383                            <imagedata scalefit="0" fileref="../media/staffclient-5.png"/>\r
384                         </imageobject>\r
385 \r
386                      </mediaobject>\r
387                      <mediaobject>\r
388                         <alt>copy/paste methods </alt>\r
389                         <imageobject>\r
390                            <imagedata scalefit="0" fileref="../media/staffclient-6.png"/>\r
391                         </imageobject>\r
392                      </mediaobject>\r
393                   </para>\r
394                </informalfigure>\r
395             </listitem>\r
396 \r
397             <listitem>\r
398                <informalfigure>\r
399                   <formalpara>\r
400                      <title>Text displayed in tables</title>\r
401                      <para>To copy information from a staff client table, first select the desired\r
402                         row then right-click and choose <guimenuitem>Copy to\r
403                         Clipboard</guimenuitem>; alternatively select <menuchoice>\r
404                            <guimenu>Actions for Selected Items</guimenu>\r
405                            <guimenuitem>Copy to Clipboard</guimenuitem>\r
406                         </menuchoice>.</para>\r
407 \r
408                   </formalpara>\r
409 \r
410                  <para> <mediaobject>\r
411                      <alt>copy/paste methods</alt>\r
412                      <imageobject>\r
413                         <imagedata scalefit="0" fileref="../media/staffclient-6a.png"/>\r
414                      </imageobject>\r
415 \r
416                   </mediaobject></para>\r
417 \r
418                </informalfigure>\r
419 \r
420                <mediaobject>\r
421                   <alt>copy/paste methods</alt>\r
422                   <imageobject>\r
423                      <imagedata scalefit="0" fileref="../media/staffclient-6b.png"/>\r
424                   </imageobject>\r
425 \r
426                </mediaobject>\r
427 \r
428                <informalfigure>\r
429                   <para>Next click the desired information in the popup to copy it to the\r
430                      clipboard</para>\r
431                   <para>\r
432                      <mediaobject>\r
433                         <alt>copy/paste methods</alt>\r
434                         <imageobject>\r
435                            <imagedata scalefit="0" fileref="../media/staffclient-6c.png"/>\r
436                         </imageobject>\r
437 \r
438                      </mediaobject>\r
439                   </para>\r
440                </informalfigure>\r
441             </listitem>\r
442 \r
443             <listitem>\r
444                <informalfigure>\r
445                   <formalpara>\r
446                      <title>Text from catalogue search results</title>\r
447                      <para>There is no right-click menu for copying data from staff client search\r
448                         results. To copy the ISBN in the example below, highlight it and click <keycombo>\r
449                            <keycap>Ctrl</keycap>\r
450                            <keycap>C</keycap>\r
451                         </keycombo>. To paste into another location use <keycombo>\r
452                            <keycap>Ctrl</keycap>\r
453                            <keycap>V</keycap>\r
454                         </keycombo>.</para>\r
455                   </formalpara>\r
456                   <para><mediaobject>\r
457                      <alt>copy/paste methods</alt>\r
458                      <imageobject>\r
459                         <imagedata scalefit="0" fileref="../media/staffclient-6d.png"/>\r
460                      </imageobject>\r
461 \r
462                   </mediaobject></para>\r
463                </informalfigure>\r
464 \r
465             </listitem>\r
466          </orderedlist>\r
467       </simplesect>\r
468    </section>\r
469    <section xml:id="staffclient-customizing">\r
470       <info>\r
471          <title>Customizing the Staff Client</title><indexterm><primary>staff client</primary><secondary>customizing</secondary></indexterm>\r
472       </info>\r
473       <simplesect>\r
474          <info>\r
475             <title>Column Picker</title>\r
476          </info>\r
477          <informalfigure>\r
478             <para>From many screens and lists, you can click on the <emphasis>column\r
479                   picker</emphasis> icon to change which columns are displayed. </para>\r
480             <para>\r
481                <mediaobject>\r
482                   <alt>screenshot of staff client column picker</alt>\r
483                   <imageobject>\r
484                      <imagedata width="100%" scalefit="1" fileref="../media/staffclient-4.png"/>\r
485 \r
486                   </imageobject>\r
487                </mediaobject>\r
488             </para>\r
489          </informalfigure>\r
490 \r
491          <para>When data is displayed in columns, you can click and drag them, add new ones, or\r
492             remove them. You can also sort data in a column by clicking on the column header. After\r
493             customizing the display you may save your changes for future sessions under that login\r
494             by right-clicking anywhere in the display area and choosing <guimenuitem>Save\r
495                Columns</guimenuitem> from the drop-down menu. Some libraries use generic accounts\r
496             and for those who do, staff need to be aware of the implications to other staff members\r
497             of any changes made to the display.</para>\r
498       </simplesect>\r
499 \r
500       <simplesect xml:id="button-bar">\r
501          <info>\r
502             <title>Button Bar</title>\r
503          </info>\r
504 \r
505 \r
506          <informalfigure>\r
507             <para>There is an optional toolbar with buttons providing quick access to common staff\r
508                client functions. When activated the toolbar appears below the menus. </para>\r
509             <para>\r
510                <mediaobject>\r
511                   <alt>staff client button bar</alt>\r
512                   <imageobject>\r
513                      <imagedata scalefit="0" fileref="../media/staffclient-9.png"/>\r
514 \r
515                   </imageobject>\r
516                </mediaobject>\r
517             </para>\r
518          </informalfigure>\r
519 \r
520          <informalfigure>\r
521             <para>To turn the buttons on or off select <menuchoice>\r
522                   <guimenu>Admin (-)</guimenu>\r
523                   <guimenuitem>Toggle Button Bar</guimenuitem>\r
524                </menuchoice>. The buttons can be activated by default for a particular library (see\r
525                   <link linkend="lsa-library-settings">Library Settings</link> for\r
526                details).</para>\r
527 \r
528             <para>\r
529                <mediaobject>\r
530                   <alt>staff client button bar</alt>\r
531                   <imageobject>\r
532                      <imagedata scalefit="0" fileref="../media/staffclient-8.png"/>\r
533 \r
534                   </imageobject>\r
535                </mediaobject>\r
536             </para>\r
537          </informalfigure>\r
538 \r
539 \r
540       </simplesect>\r
541 \r
542       <simplesect>\r
543          <info>\r
544             <title>Check-boxes</title>\r
545          </info>\r
546 \r
547          <informalfigure>\r
548             <para>Most staff client check-boxes are "sticky" -- if you select or deselect them, that\r
549                status persists. For example, <guilabel>Auto-print</guilabel>, which will print the\r
550                relevant receipts automatically in certain functions, is sticky. If you select it on\r
551                one login, it will persist for future logins until you uncheck the box.</para>\r
552 \r
553 \r
554             <para><mediaobject>\r
555                <alt>staff client tabs</alt>\r
556                <imageobject>\r
557                   <imagedata scalefit="0" fileref="../media/staffclient-7.png"/>\r
558                </imageobject>\r
559             </mediaobject></para>\r
560 \r
561          </informalfigure>\r
562 \r
563          <informalfigure>\r
564             <para><guilabel>Fast Item Add</guilabel> is another "sticky" check box that makes it\r
565                possible to add volume and item records from the MARC editor.</para>\r
566 \r
567 \r
568            <para> <mediaobject>\r
569                <alt>staff client tabs</alt>\r
570                <imageobject>\r
571                   <imagedata width="100%" scalefit="1" fileref="../media/staffclient-7a.png"/>\r
572                </imageobject>\r
573             </mediaobject></para>\r
574 \r
575          </informalfigure>\r
576 \r
577       </simplesect>\r
578 \r
579       <simplesect>\r
580          <title>Font and Sound</title>\r
581          <para>You may change the size of displayed text or turn staff client sounds on and off.\r
582             These settings are specific to each physical workstation, not the login account. See\r
583                <xref linkend="lsa-font"/> for details.</para>\r
584       </simplesect>\r
585 \r
586    </section>\r
587 \r
588 \r
589 \r
590 \r
591 </chapter>\r