1 | <?xml version="1.0" encoding="UTF-8"?> |
---|
2 | <!DOCTYPE chapter PUBLIC |
---|
3 | "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" |
---|
4 | "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd"> |
---|
5 | <!-- |
---|
6 | $Id: webclient.xml 5684 2011-08-02 15:00:19Z nicklas $ |
---|
7 | |
---|
8 | Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson |
---|
9 | |
---|
10 | This file is part of BASE - BioArray Software Environment. |
---|
11 | Available at http://base.thep.lu.se/ |
---|
12 | |
---|
13 | BASE is free software; you can redistribute it and/or |
---|
14 | modify it under the terms of the GNU General Public License |
---|
15 | as published by the Free Software Foundation; either version 3 |
---|
16 | of the License, or (at your option) any later version. |
---|
17 | |
---|
18 | BASE is distributed in the hope that it will be useful, |
---|
19 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
21 | GNU General Public License for more details. |
---|
22 | |
---|
23 | You should have received a copy of the GNU General Public License |
---|
24 | along with BASE. If not, see <http://www.gnu.org/licenses/>. |
---|
25 | --> |
---|
26 | |
---|
27 | <chapter id="webclient"> |
---|
28 | <?dbhtml dir="webclient"?> |
---|
29 | <title>Using the web client</title> |
---|
30 | <sect1 id="webclient.introduction"> |
---|
31 | <title>Introduction</title> |
---|
32 | |
---|
33 | <sect2 id="webclient.intro.login"> |
---|
34 | <title>Logging in</title> |
---|
35 | <para> |
---|
36 | There are three things that you need to know |
---|
37 | before you can use BASE: |
---|
38 | </para> |
---|
39 | |
---|
40 | <orderedlist> |
---|
41 | <listitem><simpara>The address (URL) to a BASE server</simpara></listitem> |
---|
42 | <listitem><simpara>A username to login with</simpara></listitem> |
---|
43 | <listitem><simpara>A password</simpara></listitem> |
---|
44 | </orderedlist> |
---|
45 | |
---|
46 | <para> |
---|
47 | You may, for example, try the BASE demo server. Go to the |
---|
48 | URL <ulink url="http://base2.thep.lu.se/demo/">http://base2.thep.lu.se/demo/</ulink> |
---|
49 | and enter <userinput>base2</userinput> for the login and <userinput>base2</userinput> |
---|
50 | for the password. |
---|
51 | </para> |
---|
52 | |
---|
53 | <para> |
---|
54 | You need to get all three things from an administrator |
---|
55 | of the BASE server. If you know only the address to the |
---|
56 | BASE server, you may check the front page if the administrator |
---|
57 | has added any information about how to get a username/password |
---|
58 | there. Look for the <guilabel>Get an account!</guilabel> link on |
---|
59 | the front page. |
---|
60 | </para> |
---|
61 | |
---|
62 | <para> |
---|
63 | Logging in is simple, just enter your <guilabel>login</guilabel> |
---|
64 | and <guilabel>password</guilabel> in the form on the front page |
---|
65 | and click the <guibutton>Login</guibutton> button. There is |
---|
66 | a checkbox which allows you to <guilabel>encrypt the password</guilabel> |
---|
67 | before it is sent to the BASE server. It is checked by default, and |
---|
68 | it is a good idea to leave it checked unless you have problems logging |
---|
69 | in. If you are sure you are entering the correct login and password, |
---|
70 | but still cannot log in, try unchecking the encryption option. |
---|
71 | If the checkbox is not visible, which happens if the server is |
---|
72 | using an external authentication server, the password is not encrypted. |
---|
73 | </para> |
---|
74 | </sect2> |
---|
75 | |
---|
76 | <sect2 id="webclient.intro.forgotten_password"> |
---|
77 | <title>Forgotten password</title> |
---|
78 | <para> |
---|
79 | If you forget your password you will need to get a new one. |
---|
80 | BASE stores the passwords in an encrypted form that does not allow |
---|
81 | anyone, not even the server administrator, to find out the |
---|
82 | un-encrypted password. |
---|
83 | </para> |
---|
84 | <para> |
---|
85 | To get a new password you will have to contact the server |
---|
86 | administrator. There may be a <guilabel>Forgot your password?</guilabel> |
---|
87 | link on the front page where the server administrator has entered |
---|
88 | information about how to get a new password. |
---|
89 | </para> |
---|
90 | </sect2> |
---|
91 | |
---|
92 | <sect2 id="webclient.intro.homepage"> |
---|
93 | <title>The home page</title> |
---|
94 | |
---|
95 | <para> |
---|
96 | When you have been logged in the home page will be displayed. It |
---|
97 | displays some useful information. You can also go to the home page |
---|
98 | using the |
---|
99 | <menuchoice><guimenu>View</guimenu><guimenuitem>Home</guimenuitem></menuchoice> |
---|
100 | </para> |
---|
101 | |
---|
102 | <figure id="webclient.figures.homepage"> |
---|
103 | <title>The home page</title> |
---|
104 | <screenshot> |
---|
105 | <mediaobject> |
---|
106 | <imageobject><imagedata fileref="figures/homepage.png" format="PNG" |
---|
107 | scalefit="1" width="100%"/></imageobject> |
---|
108 | </mediaobject> |
---|
109 | </screenshot> |
---|
110 | </figure> |
---|
111 | |
---|
112 | <variablelist> |
---|
113 | <varlistentry> |
---|
114 | <term><interface>New messages</interface></term> |
---|
115 | <listitem> |
---|
116 | <para> |
---|
117 | Messages are sent by plug-ins to notify you about finished jobs. In the |
---|
118 | future, you may get messages from other sources as well. As of today, |
---|
119 | messages are not used for communication between users. |
---|
120 | </para> |
---|
121 | </listitem> |
---|
122 | </varlistentry> |
---|
123 | |
---|
124 | <varlistentry> |
---|
125 | <term><interface>Projects</interface></term> |
---|
126 | <listitem> |
---|
127 | <para> |
---|
128 | A list of projects that you are a member of. Projects are an important |
---|
129 | part of BASE and are the best way to share data when you are |
---|
130 | cooperating with other users. We recommend |
---|
131 | that you always use a project when working with BASE. |
---|
132 | For more information read <xref linkend="project_permission"/>. The list |
---|
133 | displays the most recently used projects first and then fills up |
---|
134 | with the rest sorted by name. |
---|
135 | </para> |
---|
136 | </listitem> |
---|
137 | </varlistentry> |
---|
138 | |
---|
139 | <varlistentry> |
---|
140 | <term><interface>Disk usage</interface></term> |
---|
141 | <listitem> |
---|
142 | <para> |
---|
143 | An overview of how much disk space you have been assigned and |
---|
144 | how much you are using. |
---|
145 | </para> |
---|
146 | </listitem> |
---|
147 | </varlistentry> |
---|
148 | |
---|
149 | <varlistentry> |
---|
150 | <term><interface>Help</interface></term> |
---|
151 | <listitem> |
---|
152 | <para> |
---|
153 | Links for getting help and reporting bugs. The number |
---|
154 | of links displayed here may vary depending on the server |
---|
155 | configuration. |
---|
156 | </para> |
---|
157 | </listitem> |
---|
158 | </varlistentry> |
---|
159 | |
---|
160 | <varlistentry> |
---|
161 | <term><interface>News and announcements</interface></term> |
---|
162 | <listitem> |
---|
163 | <para> |
---|
164 | A list of important news and announcements from the |
---|
165 | server administrator. Here you may, for example, find |
---|
166 | information about server upgrades and maintenance. |
---|
167 | </para> |
---|
168 | </listitem> |
---|
169 | </varlistentry> |
---|
170 | </variablelist> |
---|
171 | |
---|
172 | </sect2> |
---|
173 | |
---|
174 | <sect2 id="webclient.intro.menubar"> |
---|
175 | <title>Using the menu bar</title> |
---|
176 | <para> |
---|
177 | On the top of the home page is the <interface>Menu bar</interface>. |
---|
178 | This is the main navigation tool in BASE. It works the same way |
---|
179 | as the regular menu system found in most other applications. Use |
---|
180 | the mouse to click and select an item from the menu. |
---|
181 | </para> |
---|
182 | |
---|
183 | <para> |
---|
184 | Most of the menu is in two levels, ie. clicking on a top-level menu |
---|
185 | will open a submenu just below it. Clicking on something in the |
---|
186 | submenu will take you to another page or open a pop-up dialog window. |
---|
187 | For example, the |
---|
188 | <menuchoice><guimenu>Biomaterial LIMS</guimenu><guimenuitem>Samples</guimenuitem></menuchoice> |
---|
189 | menu will take you to the page listing samples and |
---|
190 | <menuchoice><guimenu>BASE</guimenu><guimenuitem>Contact information</guimenuitem></menuchoice> |
---|
191 | opens a dialog where you can modify your contact information details. |
---|
192 | </para> |
---|
193 | |
---|
194 | <para> |
---|
195 | The menu bar also contains shortcuts to some often-used |
---|
196 | actions: |
---|
197 | </para> |
---|
198 | |
---|
199 | |
---|
200 | <variablelist> |
---|
201 | <varlistentry> |
---|
202 | <term> |
---|
203 | <guiicon> |
---|
204 | <inlinemediaobject> |
---|
205 | <imageobject><imagedata fileref="figures/project.gif" format="GIF" align="left"/></imageobject> |
---|
206 | </inlinemediaobject> |
---|
207 | </guiicon> |
---|
208 | <interface> |
---|
209 | Projects |
---|
210 | </interface> |
---|
211 | </term> |
---|
212 | <listitem> |
---|
213 | <para> |
---|
214 | A list of all projects you are a member of. The most recently used projects are |
---|
215 | listed first, then the list is filled with the rest of your projects up to a |
---|
216 | maximum of 15. If you have more projects an option to display the remaining |
---|
217 | projects is activated. Selecting a project in the list will make that project |
---|
218 | the active project. |
---|
219 | </para> |
---|
220 | <tip> |
---|
221 | <para> |
---|
222 | The sort order in the menu of non-recent projects is the same as the sort order on the |
---|
223 | projects list page. If you, for example, want to sort the newest |
---|
224 | project first (after the most recently used ones), select to sort by the |
---|
225 | <guilabel>Registered</guilabel> column in descending order on the list page. |
---|
226 | The menu will automatically use the same order. |
---|
227 | </para> |
---|
228 | </tip> |
---|
229 | </listitem> |
---|
230 | </varlistentry> |
---|
231 | <varlistentry> |
---|
232 | <term> |
---|
233 | <guiicon> |
---|
234 | <inlinemediaobject> |
---|
235 | <imageobject><imagedata fileref="figures/refresh.gif" format="GIF" align="left" |
---|
236 | /></imageobject> |
---|
237 | </inlinemediaobject> |
---|
238 | </guiicon> |
---|
239 | <interface> |
---|
240 | Refresh page |
---|
241 | </interface> |
---|
242 | </term> |
---|
243 | <listitem> |
---|
244 | <para> |
---|
245 | Refresh/reload the current page. This is useful when you add |
---|
246 | or modify items in BASE. Most of the time the page is refreshed |
---|
247 | automatically, but in some cases you will have to use |
---|
248 | this button to refresh the page. |
---|
249 | </para> |
---|
250 | |
---|
251 | <warning> |
---|
252 | <para> |
---|
253 | Do not use your browser's <guibutton>Refresh</guibutton> button. |
---|
254 | Most browsers will take you to the login page again. |
---|
255 | </para> |
---|
256 | </warning> |
---|
257 | </listitem> |
---|
258 | </varlistentry> |
---|
259 | |
---|
260 | <varlistentry> |
---|
261 | <term> |
---|
262 | <guiicon> |
---|
263 | <inlinemediaobject> |
---|
264 | <imageobject><imagedata fileref="figures/recent.png" format="PNG" align="left"/></imageobject> |
---|
265 | </inlinemediaobject> |
---|
266 | </guiicon> |
---|
267 | <interface> |
---|
268 | Recent items |
---|
269 | </interface> |
---|
270 | </term> |
---|
271 | <listitem> |
---|
272 | <para> |
---|
273 | Shortcut to the most recently viewed items. The number of items are |
---|
274 | configurable and you can also make some item types |
---|
275 | <emphasis>sticky</emphasis>. This will for example keep the shortcut |
---|
276 | to the last experiment even if you have viewed lots of other items |
---|
277 | more recently. |
---|
278 | See <xref linkend="webclient.configuration.preferences.mostrecent"/> |
---|
279 | for configuration information. |
---|
280 | </para> |
---|
281 | </listitem> |
---|
282 | </varlistentry> |
---|
283 | |
---|
284 | <varlistentry> |
---|
285 | <term> |
---|
286 | <guiicon> |
---|
287 | <inlinemediaobject> |
---|
288 | <imageobject><imagedata fileref="figures/user.png" format="PNG" align="left"/></imageobject> |
---|
289 | </inlinemediaobject> |
---|
290 | </guiicon> |
---|
291 | <interface> |
---|
292 | Logged in user |
---|
293 | </interface> |
---|
294 | </term> |
---|
295 | <listitem> |
---|
296 | <para> |
---|
297 | Displays the name of the currently logged in user and allows |
---|
298 | you to quickly log out and switch to another user. |
---|
299 | </para> |
---|
300 | </listitem> |
---|
301 | </varlistentry> |
---|
302 | |
---|
303 | </variablelist> |
---|
304 | |
---|
305 | </sect2> |
---|
306 | |
---|
307 | <sect2 id="webclient.intro.help"> |
---|
308 | <title>Getting help</title> |
---|
309 | <para> |
---|
310 | Besides reading this document there are more ways to get help: |
---|
311 | </para> |
---|
312 | <variablelist> |
---|
313 | <varlistentry> |
---|
314 | <term> |
---|
315 | On-line context-sensitive help |
---|
316 | </term> |
---|
317 | <listitem> |
---|
318 | <para> |
---|
319 | Whenever you find a small help icon |
---|
320 | (<guiicon> |
---|
321 | <inlinemediaobject> |
---|
322 | <imageobject><imagedata fileref="figures/help.gif" format="GIF" /></imageobject> |
---|
323 | </inlinemediaobject> |
---|
324 | </guiicon>) |
---|
325 | or button you may |
---|
326 | click it to get help about the part of the page |
---|
327 | you are currently viewing. The icon is located in the title |
---|
328 | bar in most pop-up dialog windows and in the toolbar in most |
---|
329 | other pages. |
---|
330 | </para> |
---|
331 | </listitem> |
---|
332 | </varlistentry> |
---|
333 | |
---|
334 | <varlistentry> |
---|
335 | <term> |
---|
336 | Using the <menuchoice><guimenu>Help</guimenu></menuchoice> menu |
---|
337 | </term> |
---|
338 | <listitem> |
---|
339 | <para> |
---|
340 | The <menuchoice><guimenu>Help</guimenu></menuchoice> menu |
---|
341 | contains links for getting on-line help. These links |
---|
342 | may be configured by a server administrator, so they may be |
---|
343 | different from server to server. By default links for reporting |
---|
344 | a bug and accessing this document are installed. |
---|
345 | </para> |
---|
346 | </listitem> |
---|
347 | </varlistentry> |
---|
348 | |
---|
349 | <varlistentry> |
---|
350 | <term> |
---|
351 | Mailing lists and other resources |
---|
352 | </term> |
---|
353 | <listitem> |
---|
354 | <para> |
---|
355 | See <xref linkend="resources" />. |
---|
356 | </para> |
---|
357 | </listitem> |
---|
358 | </varlistentry> |
---|
359 | |
---|
360 | </variablelist> |
---|
361 | |
---|
362 | </sect2> |
---|
363 | |
---|
364 | </sect1> |
---|
365 | |
---|
366 | <sect1 id="webclient.configuration"> |
---|
367 | <title>Configuring your account</title> |
---|
368 | |
---|
369 | <sect2 id="webclient.configuration.contact"> |
---|
370 | <title>Contact information</title> |
---|
371 | |
---|
372 | <para> |
---|
373 | Use the <menuchoice><guimenu>BASE</guimenu> |
---|
374 | <guimenuitem>Contact information</guimenuitem></menuchoice> |
---|
375 | menu to bring up the user information dialog. |
---|
376 | </para> |
---|
377 | |
---|
378 | <helptext external_id="userpreferences.contact" title="Contact information"> |
---|
379 | |
---|
380 | <para> |
---|
381 | This dialog has three tabs, <guilabel>Contact information</guilabel> |
---|
382 | (selected), <guilabel>Password</guilabel> and <guilabel>Other information</guilabel>. |
---|
383 | The logged in user can update the following contact information |
---|
384 | details. |
---|
385 | </para> |
---|
386 | |
---|
387 | <note> |
---|
388 | <title>Multi-user accounts</title> |
---|
389 | <para> |
---|
390 | If you are using a multi-user account, for example a demo-account, you |
---|
391 | do not have permission to change the contact information. |
---|
392 | </para> |
---|
393 | </note> |
---|
394 | |
---|
395 | <variablelist> |
---|
396 | <varlistentry> |
---|
397 | <term> |
---|
398 | <guilabel>Full name</guilabel> |
---|
399 | </term> |
---|
400 | <listitem> |
---|
401 | <para> |
---|
402 | Your full name. You are not allowed to change this. If |
---|
403 | it is not correct, contact an administrator to do it for |
---|
404 | you. |
---|
405 | </para> |
---|
406 | </listitem> |
---|
407 | </varlistentry> |
---|
408 | <varlistentry> |
---|
409 | <term> |
---|
410 | <guilabel>Email</guilabel> |
---|
411 | </term> |
---|
412 | <listitem> |
---|
413 | <para> |
---|
414 | Your email address (optional). If an email has been specified and if the |
---|
415 | server administrator has enabled email notifications, you also have the |
---|
416 | option to select if messages should be sent as emails. This can be useful |
---|
417 | to keep track of jobs that take a long time to complete. |
---|
418 | </para> |
---|
419 | </listitem> |
---|
420 | </varlistentry> |
---|
421 | <varlistentry> |
---|
422 | <term> |
---|
423 | <guilabel>Organisation</guilabel> |
---|
424 | </term> |
---|
425 | <listitem> |
---|
426 | <para> |
---|
427 | The name of the organisation you work for or represent (optional). |
---|
428 | </para> |
---|
429 | </listitem> |
---|
430 | </varlistentry> |
---|
431 | <varlistentry> |
---|
432 | <term> |
---|
433 | <guilabel>Address</guilabel> |
---|
434 | </term> |
---|
435 | <listitem> |
---|
436 | <para> |
---|
437 | Your postal address as it should be printed on letters to you |
---|
438 | (optional). |
---|
439 | </para> |
---|
440 | </listitem> |
---|
441 | </varlistentry> |
---|
442 | <varlistentry> |
---|
443 | <term> |
---|
444 | <guilabel>Phone</guilabel> |
---|
445 | </term> |
---|
446 | <listitem> |
---|
447 | <para> |
---|
448 | Your phone number (optional). You may enter multiple phone numbers, |
---|
449 | for example your work phone number and a mobile number. |
---|
450 | </para> |
---|
451 | </listitem> |
---|
452 | </varlistentry> |
---|
453 | <varlistentry> |
---|
454 | <term> |
---|
455 | <guilabel>Fax</guilabel> |
---|
456 | </term> |
---|
457 | <listitem> |
---|
458 | <para> |
---|
459 | Your fax number (optional). |
---|
460 | </para> |
---|
461 | </listitem> |
---|
462 | </varlistentry> |
---|
463 | <varlistentry> |
---|
464 | <term> |
---|
465 | <guilabel>Url</guilabel> |
---|
466 | </term> |
---|
467 | <listitem> |
---|
468 | <para> |
---|
469 | An URL to your home page or your organisation's home page (optional). |
---|
470 | </para> |
---|
471 | </listitem> |
---|
472 | </varlistentry> |
---|
473 | </variablelist> |
---|
474 | |
---|
475 | <para> |
---|
476 | Press &gbSave; to save the changes or |
---|
477 | &gbCancel; to abort. |
---|
478 | </para> |
---|
479 | |
---|
480 | <seeother> |
---|
481 | <other external_id="userpreferences.password">Change password</other> |
---|
482 | <other external_id="userpreferences.other">Other information</other> |
---|
483 | </seeother> |
---|
484 | </helptext> |
---|
485 | |
---|
486 | </sect2> |
---|
487 | |
---|
488 | <sect2 id="webclient.configuration.other"> |
---|
489 | <title>Other information</title> |
---|
490 | <para> |
---|
491 | Use the |
---|
492 | <menuchoice> |
---|
493 | <guimenu>BASE</guimenu> |
---|
494 | <guimenuitem>Other information…</guimenuitem> |
---|
495 | </menuchoice> |
---|
496 | menu to bring up the other information dialog. |
---|
497 | </para> |
---|
498 | <helptext external_id="userpreferences.other" title="Other information"> |
---|
499 | <para> |
---|
500 | This dialog has three tabs, |
---|
501 | <guilabel>Contact information</guilabel> |
---|
502 | , |
---|
503 | <guilabel>Password</guilabel> |
---|
504 | and |
---|
505 | <guilabel>Other information</guilabel> |
---|
506 | (selected) . |
---|
507 | </para> |
---|
508 | <para> |
---|
509 | The look of the |
---|
510 | <guilabel>Other information</guilabel> |
---|
511 | tab can differ a bit between different servers, depending on what settings |
---|
512 | the server is installed with. There are three inputs in a fresh BASE |
---|
513 | installation but it is only the |
---|
514 | <guilabel>Description</guilabel> |
---|
515 | text area that is static, the others can be removed or more fields can be |
---|
516 | added (managed by the server administrator). The three fields, included in a |
---|
517 | the BASE installation, are |
---|
518 | <variablelist> |
---|
519 | <varlistentry> |
---|
520 | <term> |
---|
521 | <guilabel>Mobile</guilabel> |
---|
522 | </term> |
---|
523 | <listitem> |
---|
524 | <para>Your mobile number(Optional).</para> |
---|
525 | </listitem> |
---|
526 | </varlistentry> |
---|
527 | <varlistentry> |
---|
528 | <term> |
---|
529 | <guilabel>Skype</guilabel> |
---|
530 | </term> |
---|
531 | <listitem> |
---|
532 | <para>Your Skype contact information(Optional).</para> |
---|
533 | </listitem> |
---|
534 | </varlistentry> |
---|
535 | <varlistentry> |
---|
536 | <term> |
---|
537 | <guilabel>Description</guilabel> |
---|
538 | </term> |
---|
539 | <listitem> |
---|
540 | <para> |
---|
541 | Text area where you can put useful information that couldn't |
---|
542 | be stored anywhere else(Optional). |
---|
543 | </para> |
---|
544 | </listitem> |
---|
545 | </varlistentry> |
---|
546 | </variablelist> |
---|
547 | </para> |
---|
548 | <para>Press &gbSave; to save the changes or &gbCancel; to abort.</para> |
---|
549 | <seeother> |
---|
550 | <other external_id="userpreferences.contact">Contact information</other> |
---|
551 | <other external_id="userpreferences.password">Change password</other> |
---|
552 | </seeother> |
---|
553 | </helptext> |
---|
554 | </sect2> |
---|
555 | |
---|
556 | <sect2 id="webclient.configuration.password"> |
---|
557 | <title>Changing password</title> |
---|
558 | |
---|
559 | <para> |
---|
560 | Use the <menuchoice><guimenu>BASE</guimenu> |
---|
561 | <guimenuitem>Change password</guimenuitem></menuchoice> |
---|
562 | menu to bring up the change password dialog. |
---|
563 | </para> |
---|
564 | |
---|
565 | <helptext external_id="userpreferences.password" title="Change password"> |
---|
566 | |
---|
567 | <para> |
---|
568 | This dialog has three tabs, <guilabel>Contact information</guilabel>, |
---|
569 | <guilabel>Password</guilabel> (selected) and <guilabel>Other information</guilabel>. |
---|
570 | </para> |
---|
571 | |
---|
572 | <variablelist> |
---|
573 | <varlistentry> |
---|
574 | <term> |
---|
575 | <guilabel>New password</guilabel> |
---|
576 | </term> |
---|
577 | <listitem> |
---|
578 | <para> |
---|
579 | Enter the new password. |
---|
580 | </para> |
---|
581 | </listitem> |
---|
582 | </varlistentry> |
---|
583 | <varlistentry> |
---|
584 | <term> |
---|
585 | <guilabel>Retype password</guilabel> |
---|
586 | </term> |
---|
587 | <listitem> |
---|
588 | <para> |
---|
589 | Retype the same password. You must do this to |
---|
590 | avoid spelling mistakes. |
---|
591 | </para> |
---|
592 | </listitem> |
---|
593 | </varlistentry> |
---|
594 | </variablelist> |
---|
595 | |
---|
596 | <note> |
---|
597 | <title>Multi-user accounts</title> |
---|
598 | <para> |
---|
599 | If you are using a multi-user account, for example a demo-account, you |
---|
600 | do not have permission to change the password. |
---|
601 | </para> |
---|
602 | </note> |
---|
603 | |
---|
604 | <note> |
---|
605 | <title>Empty passwords</title> |
---|
606 | <para> |
---|
607 | If you leave both fields empty the password will not be changed. It |
---|
608 | is not possible to have an empty password. |
---|
609 | </para> |
---|
610 | </note> |
---|
611 | |
---|
612 | <seeother> |
---|
613 | <other external_id="userpreferences.contact">Contact information</other> |
---|
614 | <other external_id="userpreferences.other">Other information</other> |
---|
615 | </seeother> |
---|
616 | |
---|
617 | </helptext> |
---|
618 | </sect2> |
---|
619 | |
---|
620 | <sect2 id="webclient.configuration.preferences"> |
---|
621 | <title>Preferences</title> |
---|
622 | |
---|
623 | <para> |
---|
624 | Use the <menuchoice><guimenu>BASE</guimenu> |
---|
625 | <guimenuitem>Preferences</guimenuitem></menuchoice> |
---|
626 | menu to bring up the preferences dialog. |
---|
627 | This dialog has three tabs, <guilabel>Appearance</guilabel>, |
---|
628 | <guilabel>Plugins</guilabel> and <guilabel>Recent items</guilabel>. |
---|
629 | </para> |
---|
630 | |
---|
631 | <sect3 id="webclient.configuration.preferences.appearance"> |
---|
632 | <title>The Appearance tab</title> |
---|
633 | |
---|
634 | <helptext external_id="userpreferences.appearance" title="Preferences - Appearance"> |
---|
635 | |
---|
636 | <para> |
---|
637 | This tab contains settings that affect the appearance of the |
---|
638 | web client. |
---|
639 | </para> |
---|
640 | |
---|
641 | <variablelist> |
---|
642 | <varlistentry> |
---|
643 | <term> |
---|
644 | <guilabel>Font size</guilabel> |
---|
645 | </term> |
---|
646 | <listitem> |
---|
647 | <para> |
---|
648 | Select a basic font size. You can choose between |
---|
649 | five sizes: extra small (XS), small (S), medium (M), |
---|
650 | large (L) and extra large (XL). The default font size is |
---|
651 | medium. |
---|
652 | </para> |
---|
653 | </listitem> |
---|
654 | </varlistentry> |
---|
655 | <varlistentry> |
---|
656 | <term> |
---|
657 | <guilabel>Scale factor</guilabel> |
---|
658 | </term> |
---|
659 | <listitem> |
---|
660 | <para> |
---|
661 | The scale factor affects the size of pop-up windows. |
---|
662 | This setting exists because different browsers render |
---|
663 | pages differently. If you often find that pop-up windows |
---|
664 | are too small you can change this setting to make them |
---|
665 | bigger. |
---|
666 | </para> |
---|
667 | <note> |
---|
668 | <para> |
---|
669 | The scale factor is automatically changed if the |
---|
670 | font size is changed. |
---|
671 | </para> |
---|
672 | </note> |
---|
673 | </listitem> |
---|
674 | </varlistentry> |
---|
675 | <varlistentry> |
---|
676 | <term> |
---|
677 | <guilabel>Display long texts</guilabel> |
---|
678 | </term> |
---|
679 | <listitem> |
---|
680 | <para> |
---|
681 | This setting is used to control how long description texts |
---|
682 | are displayed in tables and other places with limited space. |
---|
683 | There are three settings: |
---|
684 | </para> |
---|
685 | <itemizedlist> |
---|
686 | <listitem> |
---|
687 | <simpara> |
---|
688 | <guilabel>Always</guilabel>: The full text is always displayed. This may |
---|
689 | cause tables, etc. to become hard to read since cells will automatically |
---|
690 | grow to be able to display the full text. |
---|
691 | </simpara> |
---|
692 | </listitem> |
---|
693 | <listitem> |
---|
694 | <simpara> |
---|
695 | <guilabel>On hover</guilabel>: A short version of the text is |
---|
696 | displayed and the full text is automatically displayed when |
---|
697 | the mouse is moved over the text. Texts that are not fully |
---|
698 | visible are indicated with a dotted line to the right. |
---|
699 | </simpara> |
---|
700 | </listitem> |
---|
701 | <listitem> |
---|
702 | <simpara> |
---|
703 | <guilabel>On click</guilabel>: A short version of the text is |
---|
704 | displayed and the full text is displayed when the mouse is clicked |
---|
705 | somewhere on the short text. Texts that are not fully visible |
---|
706 | are indicated with a grey line to the right. |
---|
707 | </simpara> |
---|
708 | </listitem> |
---|
709 | </itemizedlist> |
---|
710 | |
---|
711 | <warning> |
---|
712 | The 'On click' mode may not perform so well if lots of items are |
---|
713 | displayed in a single list. This is particularly so with Internet |
---|
714 | Explorer (version 7) which is 5-10 times slower than Firefox to |
---|
715 | render the page. If you experience problems with this mode you should |
---|
716 | either use a different mode or display less items on a single page. |
---|
717 | </warning> |
---|
718 | |
---|
719 | </listitem> |
---|
720 | </varlistentry> |
---|
721 | <varlistentry> |
---|
722 | <term> |
---|
723 | <guilabel>Toolbar</guilabel> |
---|
724 | </term> |
---|
725 | <listitem> |
---|
726 | <para> |
---|
727 | You may choose if the toolbar buttons should |
---|
728 | have only images, only text or both images and text. |
---|
729 | The default is that they have both images and text. |
---|
730 | </para> |
---|
731 | </listitem> |
---|
732 | </varlistentry> |
---|
733 | <varlistentry> |
---|
734 | <term> |
---|
735 | <guilabel>Ratio color range</guilabel> |
---|
736 | </term> |
---|
737 | <listitem> |
---|
738 | <para> |
---|
739 | Select three colors to use when displaying |
---|
740 | data that is suitable for color coding, for |
---|
741 | example the intensity ratio in two-color |
---|
742 | experiments. The default setting is blue-white-yellow. |
---|
743 | The list of presets contains other useful color combinations |
---|
744 | (for example, the BASE version 1 red-yellow-green) and the most |
---|
745 | recently used color combinations. |
---|
746 | </para> |
---|
747 | </listitem> |
---|
748 | </varlistentry> |
---|
749 | <varlistentry> |
---|
750 | <term> |
---|
751 | <guilabel>Date format</guilabel> |
---|
752 | </term> |
---|
753 | <listitem> |
---|
754 | <para> |
---|
755 | A format string describing how dates should be displayed. |
---|
756 | We support all formatting options supported by the Java |
---|
757 | language. For more information see: |
---|
758 | <ulink url="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat documentation</ulink> |
---|
759 | The most useful format patterns are: |
---|
760 | </para> |
---|
761 | |
---|
762 | <itemizedlist> |
---|
763 | <listitem><simpara>yy: two-digit year</simpara></listitem> |
---|
764 | <listitem><simpara>yyyy: four-digit year</simpara></listitem> |
---|
765 | <listitem><simpara>MM: two-digit month</simpara></listitem> |
---|
766 | <listitem><simpara>MMM: month name (short)</simpara></listitem> |
---|
767 | <listitem><simpara>MMMM: month name (full)</simpara></listitem> |
---|
768 | <listitem><simpara>dd: two-digit day in month</simpara></listitem> |
---|
769 | </itemizedlist> |
---|
770 | |
---|
771 | <para> |
---|
772 | The list of presets contains the most commonly/recently |
---|
773 | used date formats. |
---|
774 | </para> |
---|
775 | |
---|
776 | </listitem> |
---|
777 | </varlistentry> |
---|
778 | |
---|
779 | <varlistentry> |
---|
780 | <term> |
---|
781 | <guilabel>Date-time format</guilabel> |
---|
782 | </term> |
---|
783 | <listitem> |
---|
784 | <para> |
---|
785 | A format string describing how dates with times should be displayed. |
---|
786 | We support all formatting options supported by the Java |
---|
787 | language. For more information see: |
---|
788 | <ulink url="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat documentations</ulink> |
---|
789 | The most useful time-format patterns are: |
---|
790 | </para> |
---|
791 | |
---|
792 | <itemizedlist> |
---|
793 | <listitem><simpara>HH: two-digit hour (0-23)</simpara></listitem> |
---|
794 | <listitem><simpara>hh: two-digit hour (1-12)</simpara></listitem> |
---|
795 | <listitem><simpara>a: AM/PM marker</simpara></listitem> |
---|
796 | <listitem><simpara>mm: two-digit minute</simpara></listitem> |
---|
797 | <listitem><simpara>ss: two-digit second</simpara></listitem> |
---|
798 | </itemizedlist> |
---|
799 | |
---|
800 | </listitem> |
---|
801 | </varlistentry> |
---|
802 | |
---|
803 | <varlistentry> |
---|
804 | <term> |
---|
805 | <guilabel>Decimals</guilabel> |
---|
806 | </term> |
---|
807 | <listitem> |
---|
808 | <para> |
---|
809 | The number of decimals to display for numerical floating point values. |
---|
810 | The default is 2. |
---|
811 | </para> |
---|
812 | </listitem> |
---|
813 | </varlistentry> |
---|
814 | |
---|
815 | </variablelist> |
---|
816 | |
---|
817 | </helptext> |
---|
818 | |
---|
819 | </sect3> |
---|
820 | |
---|
821 | <sect3 id="webclient.configuration.preferences.plugins"> |
---|
822 | <title>The Plugins tab</title> |
---|
823 | |
---|
824 | <helptext external_id="userpreferences.plugins" title="Preferences - Plugins"> |
---|
825 | |
---|
826 | <para> |
---|
827 | This tab contains settings that affect plug-in execution. |
---|
828 | </para> |
---|
829 | |
---|
830 | <variablelist> |
---|
831 | <varlistentry> |
---|
832 | <term> |
---|
833 | <guilabel>Messages</guilabel> |
---|
834 | </term> |
---|
835 | <listitem> |
---|
836 | <para> |
---|
837 | Mark the checkbox if you want to have a message sent |
---|
838 | to you when a plug-in completes execution. This setting |
---|
839 | can be overridden each time you start a plug-in. You'll |
---|
840 | receive the message as a notification in BASE, but it may |
---|
841 | also be possible to get the message as an email. |
---|
842 | </para> |
---|
843 | </listitem> |
---|
844 | </varlistentry> |
---|
845 | <varlistentry> |
---|
846 | <term> |
---|
847 | <guilabel>Remove jobs</guilabel> |
---|
848 | </term> |
---|
849 | <listitem> |
---|
850 | <para> |
---|
851 | This checkbox should be marked if you want the jobs, done by |
---|
852 | import or export plug-ins, to be marked as removed if they |
---|
853 | finished successfully. This setting can be overridden each time |
---|
854 | you start a plug-in. |
---|
855 | </para> |
---|
856 | </listitem> |
---|
857 | </varlistentry> |
---|
858 | <varlistentry> |
---|
859 | <term> |
---|
860 | <guilabel>Show warnings</guilabel> |
---|
861 | </term> |
---|
862 | <listitem> |
---|
863 | <para> |
---|
864 | This checkbox should be marked if you want to show warning |
---|
865 | messages from plug-ins in the <guilabel>Select plug-in</guilabel> |
---|
866 | dialog. Warning-level messages usually originates from plug-ins |
---|
867 | that are unrelated to the current task and are only of interest to |
---|
868 | plug-in developers. Error messages that are related to the |
---|
869 | current task are always shown. |
---|
870 | </para> |
---|
871 | </listitem> |
---|
872 | </varlistentry> |
---|
873 | </variablelist> |
---|
874 | </helptext> |
---|
875 | |
---|
876 | </sect3> |
---|
877 | |
---|
878 | <sect3 id="webclient.configuration.preferences.mostrecent"> |
---|
879 | <title>The Recent items tab</title> |
---|
880 | |
---|
881 | <helptext external_id="userpreferences.mostrecent" |
---|
882 | title="Preferences - Recent items"> |
---|
883 | |
---|
884 | <para> |
---|
885 | This tab contains settings that affect the <guilabel>Recent |
---|
886 | items</guilabel> menu and selection lists in many edit dialogs. |
---|
887 | </para> |
---|
888 | |
---|
889 | <variablelist> |
---|
890 | <varlistentry> |
---|
891 | <term> |
---|
892 | <guilabel>Recently viewed items</guilabel> |
---|
893 | </term> |
---|
894 | <listitem> |
---|
895 | <para> |
---|
896 | The number of recently <emphasis>viewed</emphasis> items to remember. |
---|
897 | The default is to remember 6 items. The remembered items |
---|
898 | will be displayed in the <guilabel>Recent items</guilabel> |
---|
899 | menu in the menu bar. |
---|
900 | </para> |
---|
901 | </listitem> |
---|
902 | </varlistentry> |
---|
903 | <varlistentry> |
---|
904 | <term> |
---|
905 | <guilabel>Recently used items</guilabel> |
---|
906 | </term> |
---|
907 | <listitem> |
---|
908 | <para> |
---|
909 | The number of recently <emphasis>used</emphasis> items to remember. |
---|
910 | The default is to remember 4 items. The remembered items will |
---|
911 | be displayed in edit dialogs where they have been used before. |
---|
912 | Each type of edit operation has it's own list of remembered items. |
---|
913 | For example, there is one list that remembers the most recently used |
---|
914 | protocols when creating a sample, and there is another list that |
---|
915 | remembers the most recently used scanners when creating a scan. |
---|
916 | </para> |
---|
917 | </listitem> |
---|
918 | </varlistentry> |
---|
919 | |
---|
920 | <varlistentry> |
---|
921 | <term> |
---|
922 | <guilabel>Load the names of all items</guilabel> |
---|
923 | </term> |
---|
924 | <listitem> |
---|
925 | <para> |
---|
926 | If checked, the names of the items will be loaded and |
---|
927 | displayed in the menu, otherwise only the ID and type of item |
---|
928 | is displayed. |
---|
929 | </para> |
---|
930 | </listitem> |
---|
931 | </varlistentry> |
---|
932 | |
---|
933 | <varlistentry> |
---|
934 | <term> |
---|
935 | <guilabel>Sticky items</guilabel> |
---|
936 | </term> |
---|
937 | <listitem> |
---|
938 | <para> |
---|
939 | Always remember the last viewed item of the selected types. |
---|
940 | For example, if you have selected <emphasis>Experiment</emphasis> |
---|
941 | as a sticky item, the last viewed experiment will be remembered |
---|
942 | even if you view hundreds of other items. Use the arrow buttons |
---|
943 | to move item types between the lists and sort the sticky items list. |
---|
944 | Sticky items will be displayed in the <guilabel>Recent items</guilabel> |
---|
945 | menu in the menu bar. |
---|
946 | </para> |
---|
947 | </listitem> |
---|
948 | </varlistentry> |
---|
949 | </variablelist> |
---|
950 | </helptext> |
---|
951 | |
---|
952 | </sect3> |
---|
953 | </sect2> |
---|
954 | |
---|
955 | </sect1> |
---|
956 | |
---|
957 | <sect1 id="webclient.items"> |
---|
958 | <title>Working with items</title> |
---|
959 | |
---|
960 | <para> |
---|
961 | No matter what you are doing in BASE some things works more |
---|
962 | or less in the same way. This section covers things that are |
---|
963 | common for most parts of BASE. |
---|
964 | </para> |
---|
965 | |
---|
966 | <para> |
---|
967 | You mostly work with a single type of item at a time. This is |
---|
968 | reflected in the menu system. For example, use |
---|
969 | <menuchoice> |
---|
970 | <guimenu>Biomaterial LIMS</guimenu> |
---|
971 | <guimenuitem>Samples</guimenuitem> |
---|
972 | </menuchoice> |
---|
973 | to work with samples, and |
---|
974 | <menuchoice> |
---|
975 | <guimenu>View</guimenu> |
---|
976 | <guimenuitem>Experiments</guimenuitem> |
---|
977 | </menuchoice> |
---|
978 | to work with experiments. In most cases the list view for that type |
---|
979 | of item is displayed. The list view, as the name says, |
---|
980 | is used to list all items. There are two more standard views, the |
---|
981 | single-item view and the edit view. |
---|
982 | </para> |
---|
983 | |
---|
984 | <variablelist> |
---|
985 | <varlistentry> |
---|
986 | <term>List view</term> |
---|
987 | <listitem> |
---|
988 | <para> |
---|
989 | This view lists all items of a certain type. The view allows you to search |
---|
990 | and it is possible to configure which information to show |
---|
991 | for each item. It also contains functions that |
---|
992 | can be used on multiple items at the same time, for example, |
---|
993 | delete, share and export. See <xref linkend="webclient.itemlist"/> for more information. |
---|
994 | </para> |
---|
995 | </listitem> |
---|
996 | </varlistentry> |
---|
997 | |
---|
998 | <varlistentry> |
---|
999 | <term>Single-item view</term> |
---|
1000 | <listitem> |
---|
1001 | <para> |
---|
1002 | Displays information about a single item. Sometimes it is very little, |
---|
1003 | sometimes it is very much and the information may be divided |
---|
1004 | into multiple tabs. |
---|
1005 | </para> |
---|
1006 | </listitem> |
---|
1007 | </varlistentry> |
---|
1008 | |
---|
1009 | <varlistentry> |
---|
1010 | <term>Edit view</term> |
---|
1011 | <listitem> |
---|
1012 | <para> |
---|
1013 | This view is used for editing the information |
---|
1014 | about a single item. It is always displayed as a pop-up window. |
---|
1015 | </para> |
---|
1016 | </listitem> |
---|
1017 | </varlistentry> |
---|
1018 | </variablelist> |
---|
1019 | |
---|
1020 | <sect2 id="webclient.items.new"> |
---|
1021 | <title>Create a new item</title> |
---|
1022 | |
---|
1023 | <para> |
---|
1024 | New items are mostly created from the list view. For example, |
---|
1025 | to create a new experiment go to the |
---|
1026 | <menuchoice><guimenu>View</guimenu> <guimenuitem>Experiments</guimenuitem></menuchoice> |
---|
1027 | page. Here you will find a &gbNew; button in the |
---|
1028 | toolbar. The button is disabled if you do not have permission to create new experiments. |
---|
1029 | Otherwise, click on it and enter any required information in the pop-up dialog. |
---|
1030 | Sometimes there are multiple tabs in this dialog. In the case of experiments |
---|
1031 | there are three tabs: <guilabel>Experiment</guilabel>, <guilabel>Publication</guilabel> |
---|
1032 | and <guilabel>Experimental factors</guilabel>. |
---|
1033 | |
---|
1034 | As a general rule, only the first tab has information that is required. |
---|
1035 | The information in all other tabs are optional. |
---|
1036 | </para> |
---|
1037 | |
---|
1038 | <para> |
---|
1039 | In some places you will also find actions that create items |
---|
1040 | directly in the list. For example in the list of samples or on |
---|
1041 | the single-item view for a sample you can create an extract using that |
---|
1042 | sample as the parent. If you use such links the parent |
---|
1043 | item will in most cases be selected automatically, which saves |
---|
1044 | you a few clicks when creating new items. |
---|
1045 | </para> |
---|
1046 | |
---|
1047 | <para> |
---|
1048 | Click on the &gbSave; button to save the new |
---|
1049 | item to the database or on the &gbCancel; button |
---|
1050 | to abort. |
---|
1051 | </para> |
---|
1052 | |
---|
1053 | <note> |
---|
1054 | <para> |
---|
1055 | To speed up data entry when adding multiple new items there |
---|
1056 | are a few tricks you can use to make the web client supply |
---|
1057 | default values for most properties. To find a default value |
---|
1058 | the following checklist is used in this order: |
---|
1059 | </para> |
---|
1060 | |
---|
1061 | <orderedlist> |
---|
1062 | <listitem> |
---|
1063 | <para> |
---|
1064 | If the list have an active filter the filter values are |
---|
1065 | used as default property values for the new item. For example, |
---|
1066 | if you are listing experiments with <guilabel>Genepix</guilabel> |
---|
1067 | raw data type the new experiment will automatically have |
---|
1068 | <guilabel>Genepix</guilabel> selected. This trick should work |
---|
1069 | for all properties except annotations, if it does not |
---|
1070 | report it as a bug to the development team. |
---|
1071 | </para> |
---|
1072 | </listitem> |
---|
1073 | |
---|
1074 | <listitem> |
---|
1075 | <para> |
---|
1076 | When you link to other items the same item will be used the next time. |
---|
1077 | For example, if you create an extract and selects an extraction protocol |
---|
1078 | the same protocol is used the next time you create another extract. |
---|
1079 | In fact, BASE will remember as many items as specified by |
---|
1080 | the |
---|
1081 | <guilabel>Recently used items</guilabel> setting (default is 4), |
---|
1082 | allowing you to quickly select one of those protocols. |
---|
1083 | <xref linkend="webclient.configuration.preferences.mostrecent" /> |
---|
1084 | contains more information about the setting. |
---|
1085 | </para> |
---|
1086 | </listitem> |
---|
1087 | |
---|
1088 | <listitem> |
---|
1089 | <para> |
---|
1090 | If you have a project active and that project has specified default |
---|
1091 | values those values will be used for new items. A project can specify |
---|
1092 | defaults for protocols, hardware and software and a few other settings. |
---|
1093 | </para> |
---|
1094 | </listitem> |
---|
1095 | |
---|
1096 | </orderedlist> |
---|
1097 | |
---|
1098 | </note> |
---|
1099 | |
---|
1100 | </sect2> |
---|
1101 | |
---|
1102 | <sect2 id="webclient.items.edit"> |
---|
1103 | <title>Edit an existing item</title> |
---|
1104 | |
---|
1105 | <para> |
---|
1106 | On all single-item views there is an &gbEdit; |
---|
1107 | button in the toolbar that opens a pop-up dialog for editing the properties |
---|
1108 | of the item. This button is disabled if the logged in user does not have |
---|
1109 | write permission for the item. |
---|
1110 | </para> |
---|
1111 | |
---|
1112 | <para> |
---|
1113 | You can also open the edit pop-up in most other places where |
---|
1114 | the item appears, for example, in lists or the single-item view |
---|
1115 | of a related item. Press and hold one of the <keycap>CTRL</keycap>, |
---|
1116 | <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking |
---|
1117 | on the link and the edit window will open in a pop-up. |
---|
1118 | If you do not have write permission |
---|
1119 | on the item there is no meaning to open the edit pop-up and you will |
---|
1120 | be taken to the single-item view page instead. |
---|
1121 | </para> |
---|
1122 | |
---|
1123 | <para> |
---|
1124 | Click on the &gbSave; button to save the changes |
---|
1125 | to the database or on the &gbCancel; button |
---|
1126 | to abort. |
---|
1127 | </para> |
---|
1128 | |
---|
1129 | </sect2> |
---|
1130 | |
---|
1131 | <sect2 id="webclient.items.delete"> |
---|
1132 | <title>Delete items</title> |
---|
1133 | |
---|
1134 | <para> |
---|
1135 | You can delete items either from the list view or from |
---|
1136 | a single-item view. In both cases, deleted items are only moved to |
---|
1137 | the trashcan. No information is removed from the database. This allows |
---|
1138 | you to restore items if you later find out that you need them again. |
---|
1139 | In fact, there is nothing special about a removed item. It can still be |
---|
1140 | used for the same things as any non-removed item can. |
---|
1141 | </para> |
---|
1142 | |
---|
1143 | <important> |
---|
1144 | <para> |
---|
1145 | To really delete items from the database you have two options: |
---|
1146 | <orderedlist> |
---|
1147 | <listitem> |
---|
1148 | <para> |
---|
1149 | Go to the trashcan |
---|
1150 | <menuchoice><guimenu>View</guimenu><guimenuitem>Trashcan</guimenuitem></menuchoice> |
---|
1151 | and delete it from there. From the trashcan you can delete several items |
---|
1152 | in one go. See <xref linkend="webclient.trashcan"/>. |
---|
1153 | </para> |
---|
1154 | </listitem> |
---|
1155 | <listitem> |
---|
1156 | <para> |
---|
1157 | Click on the small trashcan icon in the list or single-item view. |
---|
1158 | You can only delete one item at a time. |
---|
1159 | </para> |
---|
1160 | </listitem> |
---|
1161 | </orderedlist> |
---|
1162 | </para> |
---|
1163 | </important> |
---|
1164 | |
---|
1165 | <para> |
---|
1166 | To delete items from the list view you must first mark |
---|
1167 | the checkbox for each item you want to delete. Then, click on |
---|
1168 | the &gbDelete; button. The list should refresh itself |
---|
1169 | automatically. If you want to confirm that the items have been removed |
---|
1170 | use the <guilabel>view / presets</guilabel> dropdown and select |
---|
1171 | the <guilabel>Removed</guilabel> option. The removed items should now |
---|
1172 | be displayed in the list with a small trashcan icon to indicate that |
---|
1173 | they are located in the trashcan. |
---|
1174 | </para> |
---|
1175 | |
---|
1176 | <para> |
---|
1177 | To delete items from the single-item view, click on the |
---|
1178 | &gbDelete; button in the toolbar. The page will refresh |
---|
1179 | itself automatically and a small trashcan icon should be displayed. |
---|
1180 | If you do not have permission to delete the item the delete button |
---|
1181 | is disabled. |
---|
1182 | </para> |
---|
1183 | |
---|
1184 | </sect2> |
---|
1185 | |
---|
1186 | <sect2 id="webclient.items.restore"> |
---|
1187 | <title>Restore deleted items</title> |
---|
1188 | |
---|
1189 | <para> |
---|
1190 | You can restore deleted items either from the trashcan, from |
---|
1191 | the list view, or from the single-item view. This section |
---|
1192 | only covers the last two cases. The trashcan is described in |
---|
1193 | <xref linkend="webclient.trashcan"/>. |
---|
1194 | </para> |
---|
1195 | |
---|
1196 | <para> |
---|
1197 | To delete items from the list view you must first make the deleted |
---|
1198 | items appear in the list. This is easy, just use the <guilabel>view / presets</guilabel> |
---|
1199 | dropdown and select the <guilabel>Removed</guilabel> option. The list should |
---|
1200 | refresh itself automatically. The removed items are |
---|
1201 | displayed in the list with a small trashcan icon to indicate that |
---|
1202 | they are located in the trashcan. Then, mark the checkbox for each item that you want |
---|
1203 | to restore and click the &gbRestore; button. The list should |
---|
1204 | refresh itself automatically and the trashcan icon should be gone from the |
---|
1205 | restored items. |
---|
1206 | </para> |
---|
1207 | |
---|
1208 | <para> |
---|
1209 | To restore items from the single-item view, click on the |
---|
1210 | &gbRestore; button in the toolbar. The page will refresh |
---|
1211 | itself automatically and the small trashcan icon should be gone. |
---|
1212 | If you do not have permission to restore the item the restore button |
---|
1213 | is disabled. |
---|
1214 | </para> |
---|
1215 | |
---|
1216 | </sect2> |
---|
1217 | |
---|
1218 | <sect2 id="webclient.items.share"> |
---|
1219 | <title>Share items to other users</title> |
---|
1220 | <para> |
---|
1221 | Sharing data with other users is an important feature |
---|
1222 | of BASE, which allows you cooperate in teams. If you |
---|
1223 | follow the instructions in <xref linkend="project_permission" /> |
---|
1224 | you will find that you almost never have to share items manually |
---|
1225 | to other users. This is because whenever you work with an active |
---|
1226 | project each new item you create will automatically be shared |
---|
1227 | according to the settings of that project. In most cases, this |
---|
1228 | is all you need. |
---|
1229 | </para> |
---|
1230 | |
---|
1231 | <para> |
---|
1232 | If you still need to manually share your data with other users, |
---|
1233 | here is how to do it. |
---|
1234 | </para> |
---|
1235 | |
---|
1236 | <para> |
---|
1237 | From a list view, mark the checkbox for each item you want to share. |
---|
1238 | Then, click on the &gbShare; button. |
---|
1239 | If you are on a single-item page, click on the &gbShare; |
---|
1240 | button on that page. In both cases, this will open the |
---|
1241 | <guilabel>Set access permissions</guilabel> |
---|
1242 | dialog window. |
---|
1243 | </para> |
---|
1244 | |
---|
1245 | <figure id="webclient.items.share.set_permissions"> |
---|
1246 | <title>Sharing items to other users</title> |
---|
1247 | <screenshot> |
---|
1248 | <mediaobject> |
---|
1249 | <imageobject> |
---|
1250 | <imagedata fileref="figures/set_permissions.png" format="PNG" /> |
---|
1251 | </imageobject> |
---|
1252 | </mediaobject> |
---|
1253 | </screenshot> |
---|
1254 | </figure> |
---|
1255 | |
---|
1256 | <helptext external_id="share.setpermissions" title="Set access permissions"> |
---|
1257 | <variablelist> |
---|
1258 | <varlistentry> |
---|
1259 | <term><guilabel>Members</guilabel></term> |
---|
1260 | <listitem> |
---|
1261 | <para> |
---|
1262 | The list displays the users, groups and projects |
---|
1263 | that already has access to the items you selected. |
---|
1264 | The list shows the name and the permission level. |
---|
1265 | The permission level uses a one-letter code as follows: |
---|
1266 | </para> |
---|
1267 | |
---|
1268 | <itemizedlist> |
---|
1269 | <listitem><simpara><guilabel>R</guilabel> = Read</simpara></listitem> |
---|
1270 | <listitem><simpara><guilabel>U</guilabel> = Use</simpara></listitem> |
---|
1271 | <listitem><simpara><guilabel>W</guilabel> = Write</simpara></listitem> |
---|
1272 | <listitem><simpara><guilabel>D</guilabel> = Delete</simpara></listitem> |
---|
1273 | <listitem><simpara><guilabel>O</guilabel> = Set owner</simpara></listitem> |
---|
1274 | <listitem><simpara><guilabel>P</guilabel> = Set permission</simpara></listitem> |
---|
1275 | </itemizedlist> |
---|
1276 | |
---|
1277 | <para> |
---|
1278 | Instead of a permission code, the word <guilabel>varying</guilabel> |
---|
1279 | may be displayed. This happens if the items you selected have been |
---|
1280 | shared with different permission. |
---|
1281 | </para> |
---|
1282 | |
---|
1283 | <para> |
---|
1284 | The <guilabel>Permission templates</guilabel> part of the list |
---|
1285 | is always empty to begin with. |
---|
1286 | </para> |
---|
1287 | |
---|
1288 | </listitem> |
---|
1289 | </varlistentry> |
---|
1290 | |
---|
1291 | <varlistentry> |
---|
1292 | <term><guilabel>Permissions</guilabel></term> |
---|
1293 | <listitem> |
---|
1294 | <para> |
---|
1295 | When you select a user, group or project in the |
---|
1296 | list, the checkboxes will display the current permission. |
---|
1297 | The exception is if the permissions are varying, in which |
---|
1298 | case no checkboxes are checked. |
---|
1299 | To change the permissions just check the permissions you want to |
---|
1300 | grant or uncheck the permissions you want to revoke. |
---|
1301 | You can select more than one user, group or project |
---|
1302 | and change the permissions for all of them at once. |
---|
1303 | </para> |
---|
1304 | <para> |
---|
1305 | The permission boxes are disabled if a permission template |
---|
1306 | is selected. The permissions are already part of the template |
---|
1307 | and can't be changed here. |
---|
1308 | </para> |
---|
1309 | </listitem> |
---|
1310 | </varlistentry> |
---|
1311 | |
---|
1312 | <varlistentry> |
---|
1313 | <term><guibutton>Add users</guibutton></term> |
---|
1314 | <listitem> |
---|
1315 | <para> |
---|
1316 | Opens a pop-up window that allows you to select |
---|
1317 | users to share the items to. In the pop-up window, mark |
---|
1318 | one or more users and click on the &gbOk; |
---|
1319 | button. The pop-up window will only list users that you have |
---|
1320 | permission to read. Unless you are an administrator, this |
---|
1321 | usually means that you can only see users that: |
---|
1322 | </para> |
---|
1323 | <itemizedlist> |
---|
1324 | <listitem> |
---|
1325 | <para> |
---|
1326 | you share group memberships with |
---|
1327 | (the <emphasis>Everyone</emphasis> group doesn't count) |
---|
1328 | </para> |
---|
1329 | </listitem> |
---|
1330 | <listitem> |
---|
1331 | <para> |
---|
1332 | are members of the currently active project, if any. |
---|
1333 | </para> |
---|
1334 | </listitem> |
---|
1335 | </itemizedlist> |
---|
1336 | <para> |
---|
1337 | Users that already have access to the item are not included in the |
---|
1338 | list. If you don't see a user that you want to share an item to, |
---|
1339 | you'll need to talk to an administrator for setting up the proper |
---|
1340 | group membership. |
---|
1341 | </para> |
---|
1342 | </listitem> |
---|
1343 | </varlistentry> |
---|
1344 | |
---|
1345 | <varlistentry> |
---|
1346 | <term><guibutton>Add groups</guibutton></term> |
---|
1347 | <listitem> |
---|
1348 | <para> |
---|
1349 | Opens a pop-up window that allows you to select |
---|
1350 | groups to share the items to. In the pop-up window, mark |
---|
1351 | one or more groups and click on the &gbOk; |
---|
1352 | button. Unless you are an administrator, the pop-up window |
---|
1353 | will only list groups where you are a member. It will not list |
---|
1354 | groups that already have access to the items. |
---|
1355 | </para> |
---|
1356 | </listitem> |
---|
1357 | </varlistentry> |
---|
1358 | |
---|
1359 | <varlistentry> |
---|
1360 | <term><guibutton>Add projects</guibutton></term> |
---|
1361 | <listitem> |
---|
1362 | <para> |
---|
1363 | Opens a pop-up window that allows you to select |
---|
1364 | projects to share the items to. In the pop-up window, mark |
---|
1365 | one or more projects and click on the &gbOk; |
---|
1366 | button. Unless you are an administrator, the pop-up window |
---|
1367 | will only list projects where you are a member. It will not list |
---|
1368 | projects that already have access to the items. |
---|
1369 | </para> |
---|
1370 | </listitem> |
---|
1371 | </varlistentry> |
---|
1372 | |
---|
1373 | <varlistentry> |
---|
1374 | <term><guibutton>Templates</guibutton></term> |
---|
1375 | <listitem> |
---|
1376 | <para> |
---|
1377 | Opens a pop-up window that allows you to select |
---|
1378 | permission templates. In the pop-up window, mark |
---|
1379 | one or more templates and click on the &gbOk; |
---|
1380 | button. Unless you are an administrator, the pop-up window |
---|
1381 | will only list templates that you are allowed to use. It will |
---|
1382 | not list templates that have already been added. |
---|
1383 | </para> |
---|
1384 | |
---|
1385 | <note> |
---|
1386 | <para> |
---|
1387 | The permissions from the selected templates are <emphasis>copied</emphasis> |
---|
1388 | to the items when the access permissions are saved. If you re-open the share dialog, |
---|
1389 | the actual permissions are shown and the permission templates |
---|
1390 | section is empty. Modifying the permission template later doesn't |
---|
1391 | affect the permissions on existing items. See <xref linkend="project_permission.templates" /> |
---|
1392 | for more information about permission templates. |
---|
1393 | </para> |
---|
1394 | </note> |
---|
1395 | |
---|
1396 | </listitem> |
---|
1397 | </varlistentry> |
---|
1398 | |
---|
1399 | <varlistentry> |
---|
1400 | <term>&gbRemove;</term> |
---|
1401 | <listitem> |
---|
1402 | <para> |
---|
1403 | Click on this button to revoke access permissions from |
---|
1404 | the selected users, groups and projects. |
---|
1405 | </para> |
---|
1406 | </listitem> |
---|
1407 | </varlistentry> |
---|
1408 | |
---|
1409 | <varlistentry> |
---|
1410 | <term><guilabel>Apply permissions to all sub-directories and their files</guilabel></term> |
---|
1411 | <listitem> |
---|
1412 | <para> |
---|
1413 | This option shows up if at least one of the selected items |
---|
1414 | is a directory. If this option is selected the permissions given |
---|
1415 | to the directory will recursively be copied to all files and |
---|
1416 | sub-directories. Existing permissions on those items will be |
---|
1417 | overwritten with the new permissions. |
---|
1418 | </para> |
---|
1419 | </listitem> |
---|
1420 | </varlistentry> |
---|
1421 | </variablelist> |
---|
1422 | |
---|
1423 | <para> |
---|
1424 | Use the &gbSave; button to save your |
---|
1425 | changes or the &gbCancel; button to |
---|
1426 | close the pop-up without saving. |
---|
1427 | </para> |
---|
1428 | </helptext> |
---|
1429 | |
---|
1430 | </sect2> |
---|
1431 | |
---|
1432 | <sect2 id="webclient.items.changeowner"> |
---|
1433 | <title>Change owner of items</title> |
---|
1434 | <para> |
---|
1435 | Sometimes it may be necessary to change the owner of an item. |
---|
1436 | This can be done by everyone with <emphasis>Set owner</emphasis> |
---|
1437 | permission on the item. |
---|
1438 | For a user to have the rights to change owner of an item, the item must |
---|
1439 | either be owned by or shared with <emphasis>Set owner</emphasis> |
---|
1440 | permission to the user . |
---|
1441 | See <xref linkend="webclient.items.share" />. |
---|
1442 | </para> |
---|
1443 | |
---|
1444 | <para> |
---|
1445 | An user with <emphasis>Set owner</emphasis> permission can go to a list view |
---|
1446 | (or the single-item view), mark the checkboxes for the items to change owner of, |
---|
1447 | and click on the <guibutton>Set owner</guibutton> button. |
---|
1448 | A dialog window, like the screen-shot below, will appear. |
---|
1449 | </para> |
---|
1450 | <helptext external_id="ownership.configure" title="Change owner"> |
---|
1451 | <variablelist> |
---|
1452 | <varlistentry> |
---|
1453 | <term><guilabel>New owner</guilabel></term> |
---|
1454 | <listitem> |
---|
1455 | <para> |
---|
1456 | The user to be the new owner of selected item(s). |
---|
1457 | By default the current user will be selected but other |
---|
1458 | users can be picked from the <emphasis>currently used</emphasis> part of the drop-down |
---|
1459 | list or by clicking on <guibutton>Select</guibutton>. |
---|
1460 | </para> |
---|
1461 | </listitem> |
---|
1462 | </varlistentry> |
---|
1463 | </variablelist> |
---|
1464 | <para> |
---|
1465 | Use the &gbSave; button to set the new owner |
---|
1466 | or the &gbCancel; button to |
---|
1467 | close the pop-up without saving. |
---|
1468 | </para> |
---|
1469 | </helptext> |
---|
1470 | <figure id="webclient.figures.selectowner"> |
---|
1471 | <title>Select a new owner</title> |
---|
1472 | <screenshot> |
---|
1473 | <mediaobject> |
---|
1474 | <imageobject><imagedata fileref="figures/select_owner.png" format="PNG" |
---|
1475 | scalefit="1" width="100%" /></imageobject> |
---|
1476 | </mediaobject> |
---|
1477 | </screenshot> |
---|
1478 | </figure> |
---|
1479 | |
---|
1480 | <note> |
---|
1481 | <para> |
---|
1482 | The original owner may not have access permissions to the items |
---|
1483 | any longer. If that is desired, the new owner must share the items |
---|
1484 | to the original owner. |
---|
1485 | </para> |
---|
1486 | </note> |
---|
1487 | |
---|
1488 | </sect2> |
---|
1489 | |
---|
1490 | </sect1> |
---|
1491 | |
---|
1492 | <sect1 id="webclient.itemlist"> |
---|
1493 | <title>Listing items</title> |
---|
1494 | |
---|
1495 | <para> |
---|
1496 | All pages that lists items are very similar in their appearance and |
---|
1497 | functionality. In this section we will describe the things that are |
---|
1498 | common for most (if not all) list pages. |
---|
1499 | </para> |
---|
1500 | |
---|
1501 | <para> |
---|
1502 | Use the menu to open a page listing items. Most list pages can only list one type of |
---|
1503 | items. For example: use the |
---|
1504 | <menuchoice> |
---|
1505 | <guimenu>View</guimenu> |
---|
1506 | <guimenuitem>Samples</guimenuitem> |
---|
1507 | </menuchoice> |
---|
1508 | menu to list samples and the |
---|
1509 | <menuchoice> |
---|
1510 | <guimenu>View</guimenu> |
---|
1511 | <guimenuitem>Experiments</guimenuitem> |
---|
1512 | </menuchoice> |
---|
1513 | menu to list experiments. |
---|
1514 | </para> |
---|
1515 | |
---|
1516 | <tip> |
---|
1517 | An example of a list page that can list |
---|
1518 | items of several types is found by going to |
---|
1519 | <menuchoice> |
---|
1520 | <guimenu>View</guimenu> |
---|
1521 | <guimenuitem>All items</guimenuitem> |
---|
1522 | </menuchoice>. |
---|
1523 | This page lists all items that you are the owner of. It has a few limitations: |
---|
1524 | |
---|
1525 | <itemizedlist> |
---|
1526 | <listitem> |
---|
1527 | <para> |
---|
1528 | It support only a limited set of columns (id, item type, name and description) |
---|
1529 | since these are the only properties that are common among all items. It is also |
---|
1530 | possible to display sharing information. |
---|
1531 | </para> |
---|
1532 | </listitem> |
---|
1533 | |
---|
1534 | <listitem> |
---|
1535 | <para> |
---|
1536 | The list may have not have full support for filtering and |
---|
1537 | sorting. This is due to a limitation in the |
---|
1538 | query system used to generate the list. |
---|
1539 | </para> |
---|
1540 | </listitem> |
---|
1541 | </itemizedlist> |
---|
1542 | |
---|
1543 | <para> |
---|
1544 | There are also several similarities: |
---|
1545 | </para> |
---|
1546 | |
---|
1547 | <itemizedlist> |
---|
1548 | <listitem> |
---|
1549 | <para> |
---|
1550 | It supports all of the regular multi-item |
---|
1551 | operations such as delete, restore, share |
---|
1552 | and change owner. |
---|
1553 | </para> |
---|
1554 | </listitem> |
---|
1555 | |
---|
1556 | <listitem> |
---|
1557 | <para> |
---|
1558 | Clicking on the name of the item will take you to the |
---|
1559 | single-item view of that item. Holding down <keycap>CTRL</keycap>, |
---|
1560 | <keycap>ALT</keycap> or <keycap>SHIFT</keycap> while clicking, |
---|
1561 | will open the edit pop-up. |
---|
1562 | </para> |
---|
1563 | </listitem> |
---|
1564 | </itemizedlist> |
---|
1565 | |
---|
1566 | </tip> |
---|
1567 | |
---|
1568 | <figure id="webclient.figures.listpage"> |
---|
1569 | <title>A typical list page</title> |
---|
1570 | <screenshot> |
---|
1571 | <mediaobject> |
---|
1572 | <imageobject><imagedata fileref="figures/listpage.png" format="PNG" |
---|
1573 | scalefit="1" width="100%" /></imageobject> |
---|
1574 | </mediaobject> |
---|
1575 | </screenshot> |
---|
1576 | </figure> |
---|
1577 | |
---|
1578 | <para> |
---|
1579 | The typical list page contains the following important |
---|
1580 | elements: |
---|
1581 | </para> |
---|
1582 | |
---|
1583 | <variablelist> |
---|
1584 | <varlistentry> |
---|
1585 | <term><interface>1. Toolbar</interface></term> |
---|
1586 | <listitem> |
---|
1587 | <para> |
---|
1588 | A toolbar with buttons for various actions such as |
---|
1589 | &gbNew; for creating a new item, |
---|
1590 | &gbDelete; for deleting items and |
---|
1591 | <guibutton>Columns…</guibutton> for configuring columns. |
---|
1592 | Depending on the permissions of the logged in user |
---|
1593 | some buttons may be disabled (greyed out) or not shown at all. |
---|
1594 | </para> |
---|
1595 | </listitem> |
---|
1596 | </varlistentry> |
---|
1597 | |
---|
1598 | <varlistentry> |
---|
1599 | <term><interface>2. Navigation bar</interface></term> |
---|
1600 | <listitem> |
---|
1601 | <para> |
---|
1602 | If there are many items the list will be divided into |
---|
1603 | pages, each one showing a limited number of items. |
---|
1604 | The navigation bar allows you to |
---|
1605 | move to other pages and specify how many items each page |
---|
1606 | should display. The navigation bar is repeated at the |
---|
1607 | bottom of the list so you do not have to scroll back to the |
---|
1608 | top of a long list just to get to another page. |
---|
1609 | </para> |
---|
1610 | </listitem> |
---|
1611 | </varlistentry> |
---|
1612 | |
---|
1613 | <varlistentry> |
---|
1614 | <term><interface>3. List of presets</interface></term> |
---|
1615 | <listitem> |
---|
1616 | <para> |
---|
1617 | A list with preconfigured settings which allows you to |
---|
1618 | quickly switch between different layouts (sort order, visible |
---|
1619 | columns, filter settings, etc). |
---|
1620 | </para> |
---|
1621 | </listitem> |
---|
1622 | </varlistentry> |
---|
1623 | |
---|
1624 | <varlistentry> |
---|
1625 | <term><interface>4. Column headers</interface></term> |
---|
1626 | <listitem> |
---|
1627 | <para> |
---|
1628 | The columns headers can be used for selecting sort order. |
---|
1629 | </para> |
---|
1630 | </listitem> |
---|
1631 | </varlistentry> |
---|
1632 | |
---|
1633 | <varlistentry> |
---|
1634 | <term><interface>5. Filter bar</interface></term> |
---|
1635 | <listitem> |
---|
1636 | <para> |
---|
1637 | The filter bar allows you to search for items. |
---|
1638 | </para> |
---|
1639 | </listitem> |
---|
1640 | </varlistentry> |
---|
1641 | |
---|
1642 | </variablelist> |
---|
1643 | |
---|
1644 | |
---|
1645 | <sect2 id="webclient.itemlist.order"> |
---|
1646 | <title>Ordering the list</title> |
---|
1647 | |
---|
1648 | <para> |
---|
1649 | Most lists are by default sorted by the name of the item. This can |
---|
1650 | be changed by clicking on the column header of another column. |
---|
1651 | If you click on the same column twice the sort order is reversed. |
---|
1652 | A downwards or upwards pointing arrow is displayed next to the |
---|
1653 | column header in the column that is currently used for sorting. |
---|
1654 | Column headers that are black cannot be used for sorting. |
---|
1655 | </para> |
---|
1656 | |
---|
1657 | <para> |
---|
1658 | It is possible to use more than one column for sorting. Press |
---|
1659 | and hold one of the <keycap>CTRL</keycap>, |
---|
1660 | <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking |
---|
1661 | on another column header. The original sorting is kept and the new |
---|
1662 | column is used for sub-sorting the list. The procedure can be |
---|
1663 | repeated with more columns if you need to sort on three or more |
---|
1664 | columns. To revert to sort by only one column again click a |
---|
1665 | column header without holding down any key. |
---|
1666 | </para> |
---|
1667 | </sect2> |
---|
1668 | |
---|
1669 | <sect2 id="webclient.itemlist.filter"> |
---|
1670 | <title>Filtering the list</title> |
---|
1671 | |
---|
1672 | <para> |
---|
1673 | If the list contains many items you may need to use a filter to be |
---|
1674 | able to find the item you are looking for. The input boxes on the |
---|
1675 | line below the column headers are used for filtering. Most columns |
---|
1676 | are filtered using a free-text input box, but some columns that can |
---|
1677 | only take a few distinct values use a selection list or radio buttons |
---|
1678 | instead. The selection list and radio buttons are very simple to use. |
---|
1679 | Just select the alternative that you want to filter on. The list |
---|
1680 | will be automatically updated when the selection has been made. |
---|
1681 | </para> |
---|
1682 | |
---|
1683 | <para> |
---|
1684 | The free-text filter is a bit more complex. By default, an exact match is |
---|
1685 | required, use % as a wildcard character that matches any character. |
---|
1686 | For example, the filter <informalexample>Experiment A</informalexample> |
---|
1687 | only matches the same exact string, but the filter |
---|
1688 | <informalexample>Exp%</informalexample> matches |
---|
1689 | <informalexample>Experiment A, Experiment B, etc.</informalexample> |
---|
1690 | </para> |
---|
1691 | <para> |
---|
1692 | If you want to filter on several values at the same time, separate the |
---|
1693 | values in the filter input box with the <quote>|</quote> character. |
---|
1694 | For example, a filter text like <informalexample>Experiment A|C%</informalexample> |
---|
1695 | matches both <quote>Experiment A</quote> and values |
---|
1696 | that begin with <quote>C</quote>. |
---|
1697 | </para> |
---|
1698 | <para> |
---|
1699 | You can also use operators to find items which has a value that |
---|
1700 | is greater than, less than or not equal to a specific value. This is |
---|
1701 | mostly useful on numeric or date columns but also works on text |
---|
1702 | columns. The operator must be entered first in the |
---|
1703 | free-text box, for example |
---|
1704 | <informalexample><=10</informalexample> |
---|
1705 | to find items which has a value less than or equal to 10. |
---|
1706 | Here is a list of the supported operators: |
---|
1707 | </para> |
---|
1708 | |
---|
1709 | <variablelist id="webclient.itemlist.filter.operators"> |
---|
1710 | <title>List of operators supported by the free-text filter</title> |
---|
1711 | <varlistentry> |
---|
1712 | <term><keycap><</keycap></term> |
---|
1713 | <listitem><simpara>Less than</simpara></listitem> |
---|
1714 | </varlistentry> |
---|
1715 | <varlistentry> |
---|
1716 | <term><keycap><=</keycap></term> |
---|
1717 | <listitem><simpara>Less than or equal to</simpara></listitem> |
---|
1718 | </varlistentry> |
---|
1719 | <varlistentry> |
---|
1720 | <term><keycap>></keycap></term> |
---|
1721 | <listitem><simpara>Greater than</simpara></listitem> |
---|
1722 | </varlistentry> |
---|
1723 | <varlistentry> |
---|
1724 | <term><keycap>>=</keycap></term> |
---|
1725 | <listitem><simpara>Greater than or equal to</simpara></listitem> |
---|
1726 | </varlistentry> |
---|
1727 | <varlistentry> |
---|
1728 | <term><keycap>=</keycap></term> |
---|
1729 | <listitem> |
---|
1730 | <simpara> |
---|
1731 | Equal to (useful to find items with a null value). Supports |
---|
1732 | filtering on more then one value. |
---|
1733 | </simpara> |
---|
1734 | </listitem> |
---|
1735 | </varlistentry> |
---|
1736 | <varlistentry> |
---|
1737 | <term><keycap><></keycap></term> |
---|
1738 | <term><keycap>!=</keycap></term> |
---|
1739 | <listitem> |
---|
1740 | <simpara> |
---|
1741 | Not equal to (useful to find items with a non-null value). Supports |
---|
1742 | filtering on more then one value. |
---|
1743 | </simpara> |
---|
1744 | </listitem> |
---|
1745 | </varlistentry> |
---|
1746 | <varlistentry> |
---|
1747 | <term><keycap>==</keycap></term> |
---|
1748 | <listitem> |
---|
1749 | <simpara> |
---|
1750 | Same as <keycap>=</keycap> but interprets <quote>|</quote>, <quote>%</quote> |
---|
1751 | and other special characters literally. Use this when you need an exact |
---|
1752 | string match. |
---|
1753 | </simpara> |
---|
1754 | </listitem> |
---|
1755 | </varlistentry> |
---|
1756 | </variablelist> |
---|
1757 | |
---|
1758 | <sect3 id="webclient.itemlist.filter.units"> |
---|
1759 | <title>Units</title> |
---|
1760 | <para> |
---|
1761 | Some (numeric) columns have values with units. There are, for example, |
---|
1762 | the <emphasis>Original quantity</emphasis> and <emphasis>Remaining quantity</emphasis> |
---|
1763 | columns for biomaterials, which have values in micrograms (µg), and |
---|
1764 | annotations which may have any unit. |
---|
1765 | </para> |
---|
1766 | <para> |
---|
1767 | When filtering on a column that has a unit, numeric values without units are |
---|
1768 | interpreted as the default unit for that column. But it is also possible to |
---|
1769 | add a unit to the filter value. The examples below are filtering on the |
---|
1770 | original quantity column of a biomaterial: |
---|
1771 | </para> |
---|
1772 | <para> |
---|
1773 | <informalexample>>=0.5mg</informalexample> matches biomaterials with |
---|
1774 | an original quantity >=500µg. |
---|
1775 | </para> |
---|
1776 | <para> |
---|
1777 | <informalexample>=100|200|300µg</informalexample> matches biomaterials with |
---|
1778 | exactly 100, 200 or 300 micrograms. |
---|
1779 | </para> |
---|
1780 | <para> |
---|
1781 | It is also possible to mix units in a single filter: |
---|
1782 | <informalexample>=100|200|300µg|0.5|1mg</informalexample> which matches |
---|
1783 | 100, 200, 300, 500 and 1000 micrograms. |
---|
1784 | </para> |
---|
1785 | |
---|
1786 | <warning> |
---|
1787 | <title>Be aware of rounding errors</title> |
---|
1788 | <para> |
---|
1789 | All filter values with a unit that is different from the default |
---|
1790 | unit are converted to the default unit before being applied. Since |
---|
1791 | numeric conversions are never exact down to the last decimal, this may |
---|
1792 | result in problems to filter with an exact match. The last example above |
---|
1793 | could, for example, be converted to: 100, 200, 300, 500.000001 and |
---|
1794 | 999.99999998. |
---|
1795 | </para> |
---|
1796 | </warning> |
---|
1797 | |
---|
1798 | <tip> |
---|
1799 | <title>Hard-to-type characters</title> |
---|
1800 | <para> |
---|
1801 | Some units contains hard-to-type characters. For example, |
---|
1802 | the greek letter µ in µg, and m² and m³ for areas and volumes. |
---|
1803 | In all those cases it is also possible to use ug, m2 and m3, |
---|
1804 | respectively. |
---|
1805 | </para> |
---|
1806 | </tip> |
---|
1807 | |
---|
1808 | <note> |
---|
1809 | <title>Units are case-sensitive</title> |
---|
1810 | <para> |
---|
1811 | All units are case sensitive. The main reason for this is that |
---|
1812 | it must be possible to tell the difference between |
---|
1813 | <emphasis>milli (m)</emphasis> and <emphasis>mega (M)</emphasis> |
---|
1814 | prefixes, for example, <emphasis>mJ</emphasis> and <emphasis>MJ</emphasis>. |
---|
1815 | </para> |
---|
1816 | </note> |
---|
1817 | |
---|
1818 | </sect3> |
---|
1819 | </sect2> |
---|
1820 | |
---|
1821 | <sect2 id="webclient.itemlist.columns"> |
---|
1822 | <title>Configuring which columns to show</title> |
---|
1823 | |
---|
1824 | <para> |
---|
1825 | Most lists show only a small subset of the columns it |
---|
1826 | is capable of showing. Use the |
---|
1827 | <guibutton>Columns…</guibutton> button to open |
---|
1828 | a dialog that allows you to select which columns to show |
---|
1829 | and the order in which they are shown. |
---|
1830 | </para> |
---|
1831 | |
---|
1832 | <figure id="webclient.figures.configure_columns"> |
---|
1833 | <title>Configuring which columns to show</title> |
---|
1834 | <screenshot> |
---|
1835 | <mediaobject> |
---|
1836 | <imageobject> |
---|
1837 | <imagedata fileref="figures/configure_columns.png" format="PNG"/> |
---|
1838 | </imageobject> |
---|
1839 | </mediaobject> |
---|
1840 | </screenshot> |
---|
1841 | </figure> |
---|
1842 | |
---|
1843 | <helptext external_id="columns.configure" |
---|
1844 | title="Set column order and visiblity"> |
---|
1845 | |
---|
1846 | <variablelist> |
---|
1847 | <varlistentry> |
---|
1848 | <term><guilabel>Visible columns</guilabel></term> |
---|
1849 | <listitem> |
---|
1850 | <para> |
---|
1851 | Shows the columns that are currently visible. |
---|
1852 | Use the up/down arrow buttons to arrange the order of the |
---|
1853 | visible columns. The topmost column is shown to the left. |
---|
1854 | Use the right arrow button to move columns from this list |
---|
1855 | to the hidden columns list. Columns marked with an <guilabel>×</guilabel> |
---|
1856 | are required |
---|
1857 | and cannot be hidden. In most lists the <guilabel>Name</guilabel> column |
---|
1858 | is the only column that is required. |
---|
1859 | </para> |
---|
1860 | </listitem> |
---|
1861 | </varlistentry> |
---|
1862 | |
---|
1863 | <varlistentry> |
---|
1864 | <term><guilabel>Hidden columns</guilabel></term> |
---|
1865 | <listitem> |
---|
1866 | <para> |
---|
1867 | Shows columns that are not currently visible in the |
---|
1868 | list. Use the left arrow button to move columns from |
---|
1869 | this list to the visible columns list. |
---|
1870 | </para> |
---|
1871 | </listitem> |
---|
1872 | </varlistentry> |
---|
1873 | |
---|
1874 | |
---|
1875 | <varlistentry> |
---|
1876 | <term><guilabel>Presets</guilabel></term> |
---|
1877 | <listitem> |
---|
1878 | <para> |
---|
1879 | A dropdown list that allows you to |
---|
1880 | select a set of preconfigured columns. You may also create |
---|
1881 | your own preset if you often need to switch between different |
---|
1882 | configurations. The list of presets is the same as the one |
---|
1883 | described <link linkend="webclient.itemlist.presets">below</link>, |
---|
1884 | but if used from this dialog the presets only affects the visible columns |
---|
1885 | and not filters or sort order. |
---|
1886 | </para> |
---|
1887 | </listitem> |
---|
1888 | </varlistentry> |
---|
1889 | </variablelist> |
---|
1890 | |
---|
1891 | <para> |
---|
1892 | Use the &gbSave; button to apply your |
---|
1893 | changes or the &gbCancel; button to |
---|
1894 | close the pop-up without saving. |
---|
1895 | </para> |
---|
1896 | |
---|
1897 | </helptext> |
---|
1898 | |
---|
1899 | </sect2> |
---|
1900 | |
---|
1901 | <sect2 id="webclient.itemlist.presets"> |
---|
1902 | <title>Presets</title> |
---|
1903 | |
---|
1904 | <para> |
---|
1905 | The <guilabel>view / presets</guilabel> dropdown has three |
---|
1906 | main functions: |
---|
1907 | </para> |
---|
1908 | |
---|
1909 | <figure id="webclient.figures.viewpresets"> |
---|
1910 | <title>The view / presets dropdown</title> |
---|
1911 | <screenshot> |
---|
1912 | <mediaobject> |
---|
1913 | <imageobject><imagedata fileref="figures/view_presets.png" format="PNG" |
---|
1914 | /></imageobject> |
---|
1915 | </mediaobject> |
---|
1916 | </screenshot> |
---|
1917 | </figure> |
---|
1918 | <orderedlist> |
---|
1919 | <listitem> |
---|
1920 | <para> |
---|
1921 | Switch between different configuration presets. |
---|
1922 | The top of the dropdown contains user-defined presets (<guilabel>Saved preset #1</guilabel> and |
---|
1923 | <guilabel>#2</guilabel>) and a few preconfigured presets. |
---|
1924 | The user-defined presets are used to store a complete table configuration, |
---|
1925 | including: |
---|
1926 | </para> |
---|
1927 | |
---|
1928 | <itemizedlist> |
---|
1929 | <listitem><simpara>Which columns are visible and their order</simpara></listitem> |
---|
1930 | <listitem><simpara>The column (or columns) used for sorting</simpara></listitem> |
---|
1931 | <listitem><simpara>Filter settings</simpara></listitem> |
---|
1932 | <listitem><simpara>The number of items per page and the current page</simpara></listitem> |
---|
1933 | </itemizedlist> |
---|
1934 | |
---|
1935 | <para> |
---|
1936 | The preconfigured presets only affects |
---|
1937 | the visible columns as follows: |
---|
1938 | </para> |
---|
1939 | |
---|
1940 | <itemizedlist> |
---|
1941 | <listitem> |
---|
1942 | <para><guilabel>All columns</guilabel> - Show all columns.</para> |
---|
1943 | </listitem> |
---|
1944 | <listitem> |
---|
1945 | <para><guilabel>Required columns</guilabel> - Show only the required columns. |
---|
1946 | Usually only the <guilabel>Name</guilabel> column is required.</para> |
---|
1947 | </listitem> |
---|
1948 | <listitem> |
---|
1949 | <para><guilabel>Default columns</guilabel> - Show the default set of columns.</para> |
---|
1950 | </listitem> |
---|
1951 | <listitem> |
---|
1952 | <para><guilabel>Other…</guilabel> - |
---|
1953 | Open the configure columns dialog box, described in |
---|
1954 | <xref linkend="webclient.itemlist.columns"/>.</para> |
---|
1955 | </listitem> |
---|
1956 | </itemizedlist> |
---|
1957 | |
---|
1958 | </listitem> |
---|
1959 | |
---|
1960 | <listitem> |
---|
1961 | <para> |
---|
1962 | Filter items by the removed status and the access |
---|
1963 | permissions to an item. |
---|
1964 | </para> |
---|
1965 | |
---|
1966 | <itemizedlist> |
---|
1967 | <listitem> |
---|
1968 | <para><guilabel>Removed</guilabel> - If checked, items that have been |
---|
1969 | moved to the trashcan are shown, otherwise they are hidden.</para> |
---|
1970 | </listitem> |
---|
1971 | <listitem> |
---|
1972 | <para><guilabel>Owned by me</guilabel> - If checked, items that the logged in user |
---|
1973 | owns are displayed, otherwise they are hidden.</para> |
---|
1974 | </listitem> |
---|
1975 | <listitem> |
---|
1976 | <para><guilabel>Shared to me</guilabel> - If checked, items that are owned |
---|
1977 | by other users but shared to the logged in user are displayed, otherwise |
---|
1978 | they are hidden.</para> |
---|
1979 | </listitem> |
---|
1980 | <listitem> |
---|
1981 | <para><guilabel>In current project</guilabel> - |
---|
1982 | If checked, items that are linked with the current project are displayed, |
---|
1983 | otherwise they are hidden. It does not matter if the logged in user is the |
---|
1984 | owner or not. This option is only available if a project is active. |
---|
1985 | </para> |
---|
1986 | </listitem> |
---|
1987 | <listitem> |
---|
1988 | <para><guilabel>Owned by others</guilabel> - |
---|
1989 | This option is only available to administrators and will display |
---|
1990 | items that are owned by other users. |
---|
1991 | </para> |
---|
1992 | </listitem> |
---|
1993 | </itemizedlist> |
---|
1994 | |
---|
1995 | <para> |
---|
1996 | The default is to display item that the current user |
---|
1997 | owns and, if a project is active, items in that project. |
---|
1998 | </para> |
---|
1999 | |
---|
2000 | </listitem> |
---|
2001 | |
---|
2002 | <listitem> |
---|
2003 | <para> |
---|
2004 | Administrate the presets |
---|
2005 | </para> |
---|
2006 | <itemizedlist> |
---|
2007 | <listitem> |
---|
2008 | <para><guilabel>Clear filter</guilabel> - Clears |
---|
2009 | all filters.</para> |
---|
2010 | </listitem> |
---|
2011 | |
---|
2012 | <listitem> |
---|
2013 | <para><guilabel>Save as…</guilabel> - Save the |
---|
2014 | current configuration as a preset.</para> |
---|
2015 | </listitem> |
---|
2016 | |
---|
2017 | <listitem> |
---|
2018 | <para><guilabel>Manage…</guilabel> - Opens a dialog |
---|
2019 | where you can remove saved presets. You can also load |
---|
2020 | saved presets from the dialog, but it is quicker to just |
---|
2021 | use the dropdown list for this.</para> |
---|
2022 | </listitem> |
---|
2023 | </itemizedlist> |
---|
2024 | </listitem> |
---|
2025 | </orderedlist> |
---|
2026 | |
---|
2027 | <sect3 id="webclient.itemlist.presets.saveas"> |
---|
2028 | <title>Save a preset</title> |
---|
2029 | |
---|
2030 | <para> |
---|
2031 | If you select the <guilabel>Save as…</guilabel> |
---|
2032 | option from the <guilabel>view / presets</guilabel> dropdown |
---|
2033 | the <guilabel>Save preset as</guilabel> dialog is opened. |
---|
2034 | </para> |
---|
2035 | |
---|
2036 | <figure id="webclient.figures.savepresetas"> |
---|
2037 | <title>Save preset as</title> |
---|
2038 | <screenshot> |
---|
2039 | <mediaobject> |
---|
2040 | <imageobject><imagedata fileref="figures/save_preset.png" format="PNG" /></imageobject> |
---|
2041 | </mediaobject> |
---|
2042 | </screenshot> |
---|
2043 | </figure> |
---|
2044 | |
---|
2045 | <helptext external_id="contexts.saveas" title="Save preset as"> |
---|
2046 | |
---|
2047 | <variablelist> |
---|
2048 | <varlistentry> |
---|
2049 | <term><guilabel>For item</guilabel></term> |
---|
2050 | <listitem> |
---|
2051 | <para> |
---|
2052 | The type of item the preset is saved for. |
---|
2053 | </para> |
---|
2054 | </listitem> |
---|
2055 | </varlistentry> |
---|
2056 | <varlistentry> |
---|
2057 | <term><guilabel >Name</guilabel></term> |
---|
2058 | <listitem> |
---|
2059 | <para> |
---|
2060 | The name of the preset. The name must be unique. |
---|
2061 | </para> |
---|
2062 | </listitem> |
---|
2063 | </varlistentry> |
---|
2064 | <varlistentry> |
---|
2065 | <term><guilabel>Overwrite existing</guilabel></term> |
---|
2066 | <listitem> |
---|
2067 | <para> |
---|
2068 | If a preset with the same name already exists, it is |
---|
2069 | overwritten if this checkbox is checked. |
---|
2070 | </para> |
---|
2071 | </listitem> |
---|
2072 | </varlistentry> |
---|
2073 | <varlistentry> |
---|
2074 | <term><guilabel>Public</guilabel></term> |
---|
2075 | <listitem> |
---|
2076 | <para> |
---|
2077 | This options is only available for users |
---|
2078 | which has the <emphasis>SHARE_TO_EVERYONE</emphasis> |
---|
2079 | permission. If checked the preset is visible to |
---|
2080 | all users. |
---|
2081 | </para> |
---|
2082 | </listitem> |
---|
2083 | </varlistentry> |
---|
2084 | </variablelist> |
---|
2085 | |
---|
2086 | <para> |
---|
2087 | Use the &gbOk; button to save the preset |
---|
2088 | or the &gbCancel; button to |
---|
2089 | close the pop-up without saving. |
---|
2090 | </para> |
---|
2091 | |
---|
2092 | |
---|
2093 | </helptext> |
---|
2094 | |
---|
2095 | </sect3> |
---|
2096 | |
---|
2097 | <sect3 id="webclient.itemlist.presets.manage"> |
---|
2098 | <title>Manage presets</title> |
---|
2099 | |
---|
2100 | <para> |
---|
2101 | If you select the <guilabel>Manage…</guilabel> |
---|
2102 | option from the <guilabel>view / presets</guilabel> dropdown |
---|
2103 | the <guilabel>Manage presets</guilabel> dialog is opened. |
---|
2104 | </para> |
---|
2105 | |
---|
2106 | <figure id="webclient.figures.managepresets"> |
---|
2107 | <title>Manage presets</title> |
---|
2108 | <screenshot> |
---|
2109 | <mediaobject> |
---|
2110 | <imageobject><imagedata fileref="figures/manage_presets.png" format="PNG" /></imageobject> |
---|
2111 | </mediaobject> |
---|
2112 | </screenshot> |
---|
2113 | </figure> |
---|
2114 | |
---|
2115 | <helptext external_id="contexts.manage" title="Manage presets"> |
---|
2116 | |
---|
2117 | <para> |
---|
2118 | From this dialog you can delete or load presets. |
---|
2119 | </para> |
---|
2120 | |
---|
2121 | <para> |
---|
2122 | To delete presets, first mark the checkbox in front of |
---|
2123 | each preset you want to delete. Then, click on the |
---|
2124 | <guibutton>Delete…</guibutton> button. You will get |
---|
2125 | a warning about that the action cannot be undone. Unlike other |
---|
2126 | items, the presets are not moved to the trashcan. Click on |
---|
2127 | &gbOk; to delete the preset. |
---|
2128 | </para> |
---|
2129 | |
---|
2130 | <note> |
---|
2131 | <title>Edit a preset</title> |
---|
2132 | <para> |
---|
2133 | It is not possible to edit a preset directly. To change an |
---|
2134 | existing preset you must: |
---|
2135 | |
---|
2136 | <orderedlist> |
---|
2137 | <listitem><simpara>Load the preset.</simpara></listitem> |
---|
2138 | <listitem><simpara>Use the interface to change column settings, filter, |
---|
2139 | sort order, etc.</simpara></listitem> |
---|
2140 | <listitem><simpara>Save the preset with the same name.</simpara></listitem> |
---|
2141 | </orderedlist> |
---|
2142 | </para> |
---|
2143 | </note> |
---|
2144 | |
---|
2145 | <para> |
---|
2146 | Use the &gbClose; button to |
---|
2147 | close the pop-up. |
---|
2148 | </para> |
---|
2149 | |
---|
2150 | |
---|
2151 | </helptext> |
---|
2152 | |
---|
2153 | </sect3> |
---|
2154 | |
---|
2155 | </sect2> |
---|
2156 | </sect1> |
---|
2157 | |
---|
2158 | |
---|
2159 | <sect1 id="webclient.trashcan"> |
---|
2160 | <title>Trashcan</title> |
---|
2161 | <para> |
---|
2162 | All items that have been deleted, and are owned by you, are |
---|
2163 | listed in your trashcan. This list page is accessed with |
---|
2164 | <menuchoice> |
---|
2165 | <guimenu>View</guimenu> |
---|
2166 | <guimenuitem>Trashcan</guimenuitem> |
---|
2167 | </menuchoice> |
---|
2168 | and it differs a bit from the other common list pages. The |
---|
2169 | most significant difference is that the trashcan page can |
---|
2170 | contain more then one item type, actually all removable item |
---|
2171 | types in BASE can be listed in the trashcan. Items that neither |
---|
2172 | can be removed or deleted, <emphasis>i.e.,</emphasis> items |
---|
2173 | like sessions, nor clients' help texts since these are deleted |
---|
2174 | from the database immediately in list/item view will be shown |
---|
2175 | in the trashcan page. |
---|
2176 | </para> |
---|
2177 | <warning> |
---|
2178 | <para> |
---|
2179 | Some item types do not have any owner and these are listed |
---|
2180 | in the trashcans for everyone with delete permission on that |
---|
2181 | specific item type. |
---|
2182 | </para> |
---|
2183 | </warning> |
---|
2184 | |
---|
2185 | <para> |
---|
2186 | Things that the trashcan page have in common with other list |
---|
2187 | pages are the possibility to restore and view/edit items, see |
---|
2188 | <xref linkend="webclient.items.restore" /> and |
---|
2189 | <xref linkend="webclient.items.edit" /> . If an item is |
---|
2190 | restored, it will of course disappear from the trashcan. |
---|
2191 | </para> |
---|
2192 | |
---|
2193 | <sect2 id="webclient.trashcan.deleteitem"> |
---|
2194 | <title>Delete items permanently</title> |
---|
2195 | <para> |
---|
2196 | Items can be permanently deleted from BASE only if they are |
---|
2197 | not used by other items. Items that are used have the icon |
---|
2198 | <inlinemediaobject> |
---|
2199 | <imageobject> |
---|
2200 | <imagedata fileref="figures/isused.gif" format="GIF" /> |
---|
2201 | </imageobject> |
---|
2202 | </inlinemediaobject> |
---|
2203 | in the first column and by clicking on it you can get more |
---|
2204 | information about the dependencies, see |
---|
2205 | <xref linkend="webclient.trashcan.viewdependencies" /> . |
---|
2206 | <note> |
---|
2207 | <simpara> |
---|
2208 | This view is NOT the same view page as when clicking on |
---|
2209 | the item's name, which brings you to the item's view |
---|
2210 | page. |
---|
2211 | </simpara> |
---|
2212 | </note> |
---|
2213 | </para> |
---|
2214 | <para> |
---|
2215 | To delete one or several items permanently from the trashcan |
---|
2216 | you first have to select them and then to click on the |
---|
2217 | &gbDelete; button. Press then on either &gbOk; (completes |
---|
2218 | the deletion) or &gbCancel; (no items will be deleted) in |
---|
2219 | the dialog window that appears. |
---|
2220 | </para> |
---|
2221 | |
---|
2222 | <sect3 id="webclient.trashcan.deleteitem.empty"> |
---|
2223 | <title>Empty trashcan</title> |
---|
2224 | <para> |
---|
2225 | If all items in the trashcan should be deleted permanently |
---|
2226 | the <guibutton>Empty trash</guibutton> button can be |
---|
2227 | used. This function will remove all items that are listed |
---|
2228 | in your trashcan, except those items which other items, |
---|
2229 | not marked for deletion or cannot be deleted, are |
---|
2230 | dependent on. |
---|
2231 | </para> |
---|
2232 | </sect3> |
---|
2233 | </sect2> |
---|
2234 | |
---|
2235 | <sect2 id="webclient.trashcan.viewdependencies"> |
---|
2236 | <title>View dependencies of a trashed item</title> |
---|
2237 | <helptext external_id="trash.view.properties" title="Properties for a trashed item"> |
---|
2238 | <para> |
---|
2239 | This view can only be accessed from trashed items that are |
---|
2240 | linked together with other items. Beside the item's |
---|
2241 | <guilabel>item type</guilabel>, <guilabel>name</guilabel>, |
---|
2242 | and <guilabel>description</guilabel> there is a list at |
---|
2243 | the bottom of the view page with those items that are |
---|
2244 | using the current item in some way. |
---|
2245 | </para> |
---|
2246 | </helptext> |
---|
2247 | <para> |
---|
2248 | <nohelp> |
---|
2249 | <figure id="webclient.trashcan.figures.viewtrasheditem"> |
---|
2250 | <title>Item view of a trashed item.</title> |
---|
2251 | <screenshot> |
---|
2252 | <mediaobject> |
---|
2253 | <imageobject> |
---|
2254 | <imagedata fileref="figures/trashview.png" format="PNG" |
---|
2255 | scalefit="1" width="100%" /> |
---|
2256 | </imageobject> |
---|
2257 | </mediaobject> |
---|
2258 | </screenshot> |
---|
2259 | </figure> |
---|
2260 | </nohelp> |
---|
2261 | <orderedlist> |
---|
2262 | <listitem> |
---|
2263 | <para> |
---|
2264 | This icon indicates that the item cannot be deleted |
---|
2265 | permanently cause of some dependencies, see |
---|
2266 | #<xref linkend="webclient.trashcan.lists.dependentitem3" />. |
---|
2267 | </para> |
---|
2268 | </listitem> |
---|
2269 | <listitem> |
---|
2270 | <para>Common properties for all removable items.</para> |
---|
2271 | </listitem> |
---|
2272 | <listitem id="webclient.trashcan.lists.dependentitem3"> |
---|
2273 | <para>A list of other items that are using the current item.</para> |
---|
2274 | </listitem> |
---|
2275 | </orderedlist> |
---|
2276 | </para> |
---|
2277 | </sect2> |
---|
2278 | </sect1> |
---|
2279 | |
---|
2280 | <sect1 id="webclient.itemoverview"> |
---|
2281 | <title>Item overview</title> |
---|
2282 | |
---|
2283 | <helptext external_id="item.overview" |
---|
2284 | title="Item overview"> |
---|
2285 | |
---|
2286 | <para> |
---|
2287 | With the <guilabel>Item overview</guilabel> |
---|
2288 | function you can get an overview of all bioassays, |
---|
2289 | extracts, samples, annotations, raw data sets, etc. that are |
---|
2290 | related to a given item. In the overview you can also validate |
---|
2291 | the data to find possibly missing or incorrect information. |
---|
2292 | </para> |
---|
2293 | |
---|
2294 | <nohelp> |
---|
2295 | <para> |
---|
2296 | You can access the overview for an item by navigating |
---|
2297 | to the single-item view of the item you are interested in. |
---|
2298 | Then, switch to the <guilabel>Overview</guilabel> tab that |
---|
2299 | is present on that page. Here is an example of what is displayed: |
---|
2300 | </para> |
---|
2301 | |
---|
2302 | <figure id="webclient.figures.itemoverview"> |
---|
2303 | <title>The item overview</title> |
---|
2304 | <screenshot> |
---|
2305 | <mediaobject> |
---|
2306 | <imageobject><imagedata |
---|
2307 | scalefit="1" width="100%" |
---|
2308 | fileref="figures/item_overview.png" format="PNG" |
---|
2309 | /></imageobject> |
---|
2310 | </mediaobject> |
---|
2311 | </screenshot> |
---|
2312 | </figure> |
---|
2313 | </nohelp> |
---|
2314 | |
---|
2315 | <para> |
---|
2316 | The page is divided into three sections: |
---|
2317 | </para> |
---|
2318 | |
---|
2319 | <itemizedlist> |
---|
2320 | <listitem> |
---|
2321 | <para> |
---|
2322 | To the left is a tree displaying items that are related |
---|
2323 | to the current item. The tree is loaded gradually when |
---|
2324 | you click your way through the sublevels. |
---|
2325 | The only exception is after a validation has been done, |
---|
2326 | in this case the whole tree is loaded through the validation-process. |
---|
2327 | </para> |
---|
2328 | </listitem> |
---|
2329 | |
---|
2330 | <listitem> |
---|
2331 | <para> |
---|
2332 | The lower right shows a list of warnings and error |
---|
2333 | messages that was found when validating the data. |
---|
2334 | This section is empty if no validation has been done. |
---|
2335 | Click on the <guibutton>Validate</guibutton> button |
---|
2336 | to validate the data and load errors and warnings. |
---|
2337 | <nohelp> |
---|
2338 | In the example you can see that we have failed to |
---|
2339 | specify a value for the <guilabel>Temperature</guilabel> |
---|
2340 | protocol parameter for one of the samples. |
---|
2341 | </nohelp> |
---|
2342 | </para> |
---|
2343 | </listitem> |
---|
2344 | |
---|
2345 | <listitem> |
---|
2346 | <para> |
---|
2347 | The upper right shows information about the |
---|
2348 | currently selected item in the tree. This part will also |
---|
2349 | contain more information about errors or warnings for this |
---|
2350 | item, but only if a validation has been done. |
---|
2351 | It may also present you with one or more suggestions |
---|
2352 | about how to fix the problem and with a link that |
---|
2353 | takes you to the most probable location where you can fix |
---|
2354 | the error or warning. |
---|
2355 | </para> |
---|
2356 | |
---|
2357 | <note> |
---|
2358 | <title>No links?</title> |
---|
2359 | If you do not have permission to change things no links |
---|
2360 | will be shown. |
---|
2361 | </note> |
---|
2362 | |
---|
2363 | </listitem> |
---|
2364 | |
---|
2365 | </itemizedlist> |
---|
2366 | |
---|
2367 | <seeother> |
---|
2368 | <other external_id="item.overview.validationoptions" |
---|
2369 | >Validation options</other> |
---|
2370 | <other external_id="item.overview.fixfailures" |
---|
2371 | >How to fix validation failures</other> |
---|
2372 | </seeother> |
---|
2373 | |
---|
2374 | </helptext> |
---|
2375 | |
---|
2376 | <sect2 id="webclient.itemoverview.validationoptions"> |
---|
2377 | <title>Validation options</title> |
---|
2378 | <para> |
---|
2379 | Click on the <guibutton>Validation options</guibutton> |
---|
2380 | button in the toolbar to open the <guilabel>Validation |
---|
2381 | options</guilabel> dialog. |
---|
2382 | </para> |
---|
2383 | |
---|
2384 | <figure id="webclient.figures.validationoptions"> |
---|
2385 | <title>Validation options</title> |
---|
2386 | <screenshot> |
---|
2387 | <mediaobject> |
---|
2388 | <imageobject><imagedata |
---|
2389 | fileref="figures/validation_options.png" format="PNG" |
---|
2390 | /></imageobject> |
---|
2391 | </mediaobject> |
---|
2392 | </screenshot> |
---|
2393 | </figure> |
---|
2394 | |
---|
2395 | <helptext external_id="item.overview.validationoptions" |
---|
2396 | title="Validation options"> |
---|
2397 | <para> |
---|
2398 | The validation procedure is highly |
---|
2399 | configurable and you can select what you want to |
---|
2400 | ignore, and what should be displayed as an error |
---|
2401 | or warning. |
---|
2402 | </para> |
---|
2403 | |
---|
2404 | <variablelist> |
---|
2405 | <varlistentry> |
---|
2406 | <term> |
---|
2407 | <guilabel>Presets</guilabel></term> |
---|
2408 | <listitem> |
---|
2409 | <para> |
---|
2410 | The list contains predefined and |
---|
2411 | user defined validation options. |
---|
2412 | Use the <guibutton>Save as…</guibutton> |
---|
2413 | button to save the current options as a user defined |
---|
2414 | preset. The <guibutton>Remove…</guibutton> |
---|
2415 | button is used to remove the currently selected |
---|
2416 | preset. Predefined presets cannot be deleted. |
---|
2417 | </para> |
---|
2418 | </listitem> |
---|
2419 | </varlistentry> |
---|
2420 | |
---|
2421 | <varlistentry> |
---|
2422 | <term><guilabel>Project defaults</guilabel></term> |
---|
2423 | <listitem> |
---|
2424 | <para> |
---|
2425 | The options in this section are used to check |
---|
2426 | if your experiment uses the same values as set |
---|
2427 | by the project default values of the currently active |
---|
2428 | project<nohelp> |
---|
2429 | (see <xref linkend="project_permission.projects" />)</nohelp>. |
---|
2430 | If no project is active or if the active project does not |
---|
2431 | have default values these options are ignored. |
---|
2432 | </para> |
---|
2433 | </listitem> |
---|
2434 | |
---|
2435 | </varlistentry> |
---|
2436 | |
---|
2437 | <varlistentry> |
---|
2438 | <term><guilabel>Missing items</guilabel></term> |
---|
2439 | <listitem> |
---|
2440 | <para> |
---|
2441 | The options in this section are used to check if |
---|
2442 | you have specified values for optional items. |
---|
2443 | For example, there is an option that warns you if |
---|
2444 | you have not specified a protocol. |
---|
2445 | </para> |
---|
2446 | </listitem> |
---|
2447 | </varlistentry> |
---|
2448 | |
---|
2449 | <varlistentry> |
---|
2450 | <term><guilabel>Subtypes</guilabel></term> |
---|
2451 | <listitem> |
---|
2452 | <para> |
---|
2453 | The options in this section are used to check that related items |
---|
2454 | have a subtype that matches the subtype of the main item. For example, |
---|
2455 | if we have an <emphasis>extract</emphasis> |
---|
2456 | which is a <emphasis>labeled extract</emphasis> subtype the subtype for |
---|
2457 | the related tag should be <emphasis>label</emphasis>, but if the extract |
---|
2458 | is a <emphasis>library</emphasis> the subtype of the tag should be |
---|
2459 | <emphasis>barcode</emphasis>. |
---|
2460 | </para> |
---|
2461 | </listitem> |
---|
2462 | </varlistentry> |
---|
2463 | |
---|
2464 | <varlistentry> |
---|
2465 | <term><guilabel>Annotations</guilabel></term> |
---|
2466 | <listitem> |
---|
2467 | <para> |
---|
2468 | The options in this section are used to check |
---|
2469 | problems related to annotations. The most |
---|
2470 | important ones are listed here: |
---|
2471 | </para> |
---|
2472 | |
---|
2473 | <itemizedlist> |
---|
2474 | <listitem> |
---|
2475 | <simpara> |
---|
2476 | <emphasis>Missing MIAME annotation value</emphasis>: |
---|
2477 | Checks that you have specified values |
---|
2478 | for all annotations marked as |
---|
2479 | <guilabel>Required for MIAME</guilabel>. |
---|
2480 | </simpara> |
---|
2481 | </listitem> |
---|
2482 | |
---|
2483 | <listitem> |
---|
2484 | <simpara> |
---|
2485 | <emphasis>Missing factor value</emphasis>: |
---|
2486 | Checks that you have specified values for |
---|
2487 | all annotations used as experimental factors in |
---|
2488 | the experiment. This is only checked when an experiment |
---|
2489 | is selected as the root item. |
---|
2490 | </simpara> |
---|
2491 | </listitem> |
---|
2492 | |
---|
2493 | <listitem> |
---|
2494 | <simpara> |
---|
2495 | <emphasis>Missing parameter value</emphasis>: |
---|
2496 | Checks that you have specified values |
---|
2497 | for all protocol parameters. |
---|
2498 | </simpara> |
---|
2499 | </listitem> |
---|
2500 | |
---|
2501 | <listitem> |
---|
2502 | <simpara> |
---|
2503 | <emphasis>Annotation is protocol parameter</emphasis>: |
---|
2504 | Checks if an item has been annotated with a |
---|
2505 | an annotation that is actually a protocol parameter. |
---|
2506 | </simpara> |
---|
2507 | </listitem> |
---|
2508 | |
---|
2509 | <listitem> |
---|
2510 | <simpara> |
---|
2511 | <emphasis>Annotation has invalid value</emphasis>: |
---|
2512 | Checks if annotation values are correct with |
---|
2513 | respect to the rules given by the annotation type. |
---|
2514 | This might include numeric values that are outside |
---|
2515 | the valid range, or values not in the list |
---|
2516 | of allows values for an enumerated annotation type. |
---|
2517 | </simpara> |
---|
2518 | </listitem> |
---|
2519 | |
---|
2520 | <listitem> |
---|
2521 | <simpara> |
---|
2522 | <emphasis>Inheriting annotation from non-parent</emphasis>: |
---|
2523 | Checks if inherited annotations really comes from a |
---|
2524 | parent item. This might happen if you rearrange |
---|
2525 | parent-child relationship because you found that |
---|
2526 | they were incorrectly linked. |
---|
2527 | </simpara> |
---|
2528 | </listitem> |
---|
2529 | </itemizedlist> |
---|
2530 | |
---|
2531 | |
---|
2532 | </listitem> |
---|
2533 | </varlistentry> |
---|
2534 | |
---|
2535 | <varlistentry> |
---|
2536 | <term><guilabel>Files</guilabel></term> |
---|
2537 | <listitem> |
---|
2538 | <para> |
---|
2539 | The options in this section are related to the validity of |
---|
2540 | data files that can be attached to some items, for example, |
---|
2541 | raw bioassays and array designs. The data files are usually |
---|
2542 | validated immediately when they are used and the result is saved |
---|
2543 | to the database. The options in this dialog can be used to find |
---|
2544 | (or ignore) problems with data files. |
---|
2545 | </para> |
---|
2546 | </listitem> |
---|
2547 | </varlistentry> |
---|
2548 | |
---|
2549 | |
---|
2550 | <varlistentry> |
---|
2551 | <term><guilabel>Denied access</guilabel></term> |
---|
2552 | <listitem> |
---|
2553 | <para> |
---|
2554 | The options in this section are used to |
---|
2555 | check if you do not have access (read permission) |
---|
2556 | to an item in the experiment hierarchy. If this |
---|
2557 | happens the validation cannot proceed in that branch. |
---|
2558 | This might mask other validation problems. |
---|
2559 | </para> |
---|
2560 | </listitem> |
---|
2561 | </varlistentry> |
---|
2562 | |
---|
2563 | <varlistentry> |
---|
2564 | <term><guilabel>Other</guilabel></term> |
---|
2565 | <listitem> |
---|
2566 | <para> |
---|
2567 | This section collects options that does not fit |
---|
2568 | into any of the other sections. The most |
---|
2569 | important options are: |
---|
2570 | </para> |
---|
2571 | |
---|
2572 | <itemizedlist> |
---|
2573 | <listitem> |
---|
2574 | <simpara> |
---|
2575 | <emphasis>Array design mismatch</emphasis>: |
---|
2576 | Checks if the array design specified for |
---|
2577 | a raw bioassay is the same array design |
---|
2578 | specified for the physical bioassay. |
---|
2579 | </simpara> |
---|
2580 | </listitem> |
---|
2581 | |
---|
2582 | <listitem> |
---|
2583 | <simpara> |
---|
2584 | <emphasis>Multiple array designs</emphasis>: |
---|
2585 | Checks if all raw bioassays in an experiment |
---|
2586 | use the same array design or not. This is only |
---|
2587 | checked when the root item is an experiment. |
---|
2588 | </simpara> |
---|
2589 | </listitem> |
---|
2590 | |
---|
2591 | <listitem> |
---|
2592 | <simpara> |
---|
2593 | <emphasis>(Incorrect number of labled extracts)</emphasis>: |
---|
2594 | Checks if the number of labeled extracts |
---|
2595 | match the number of channels for the experiment. |
---|
2596 | This is only checked when the root item is an experiment. |
---|
2597 | </simpara> |
---|
2598 | </listitem> |
---|
2599 | |
---|
2600 | <listitem> |
---|
2601 | <simpara> |
---|
2602 | <emphasis>Non-unique name</emphasis>: |
---|
2603 | Checks if two items of the same type |
---|
2604 | have the same name. It is usually a good idea to |
---|
2605 | have unique names within an experiment if the data is |
---|
2606 | going to be exported and in other circumstances. |
---|
2607 | </simpara> |
---|
2608 | </listitem> |
---|
2609 | |
---|
2610 | <listitem> |
---|
2611 | <simpara> |
---|
2612 | <emphasis>Circular reference to pooled item</emphasis>: |
---|
2613 | If you have used pooling, checks that no |
---|
2614 | circular references have been created. |
---|
2615 | </simpara> |
---|
2616 | </listitem> |
---|
2617 | |
---|
2618 | </itemizedlist> |
---|
2619 | |
---|
2620 | </listitem> |
---|
2621 | </varlistentry> |
---|
2622 | |
---|
2623 | </variablelist> |
---|
2624 | |
---|
2625 | <para> |
---|
2626 | Click on the &gbSave; button |
---|
2627 | to use the current settings. The display will |
---|
2628 | automatically refresh itself. |
---|
2629 | </para> |
---|
2630 | |
---|
2631 | </helptext> |
---|
2632 | |
---|
2633 | <helptext external_id="item.overview.validationoptions.savepreset" |
---|
2634 | title="Save preset" webonly="1"> |
---|
2635 | |
---|
2636 | <para> |
---|
2637 | Saves all validation options as a preset. |
---|
2638 | </para> |
---|
2639 | |
---|
2640 | <variablelist> |
---|
2641 | <varlistentry> |
---|
2642 | <term><guilabel>Name</guilabel></term> |
---|
2643 | <listitem> |
---|
2644 | <para> |
---|
2645 | The name of the preset. The name must be unique |
---|
2646 | and if a preset with the same name already exists |
---|
2647 | you will be asked if you want to overwrite it or not. |
---|
2648 | </para> |
---|
2649 | </listitem> |
---|
2650 | </varlistentry> |
---|
2651 | </variablelist> |
---|
2652 | |
---|
2653 | <para> |
---|
2654 | Click on the &gbSave; button |
---|
2655 | to save the preset or &gbCancel; |
---|
2656 | to abort. |
---|
2657 | </para> |
---|
2658 | </helptext> |
---|
2659 | |
---|
2660 | </sect2> |
---|
2661 | |
---|
2662 | <sect2 id="webclient.itemoverview.fixfailures"> |
---|
2663 | <title>Fixing validation failures</title> |
---|
2664 | <helptext external_id="item.overview.fixfailures" |
---|
2665 | title="How to fix validation failures"> |
---|
2666 | |
---|
2667 | <para> |
---|
2668 | The overview includes a function that allows |
---|
2669 | you to quickly fix most of the problems found during the |
---|
2670 | validation. The easiest way to use the function is: |
---|
2671 | </para> |
---|
2672 | |
---|
2673 | <orderedlist> |
---|
2674 | <listitem> |
---|
2675 | <simpara> |
---|
2676 | Click on an error or warning in the list of failures in |
---|
2677 | the lower right |
---|
2678 | pane. The tree in the left pane and the item overview in the |
---|
2679 | top right pane will automatically be updated to show the |
---|
2680 | exact location of the faulty item. |
---|
2681 | </simpara> |
---|
2682 | </listitem> |
---|
2683 | <listitem> |
---|
2684 | <simpara> |
---|
2685 | The upper right pane should contain a list labeled |
---|
2686 | <guilabel>Failure details</guilabel> with more information |
---|
2687 | about each failure and also one or more suggestions for fixing |
---|
2688 | the problem. For example, a failure due to a missing item |
---|
2689 | should suggest that you add or select an item. |
---|
2690 | </simpara> |
---|
2691 | </listitem> |
---|
2692 | |
---|
2693 | <listitem> |
---|
2694 | <simpara> |
---|
2695 | The suggestions should also have links that takes |
---|
2696 | you to an edit view where you can do the changes. |
---|
2697 | </simpara> |
---|
2698 | </listitem> |
---|
2699 | |
---|
2700 | <listitem> |
---|
2701 | <simpara> |
---|
2702 | After saving the changes you must click on the |
---|
2703 | <guibutton>Validate</guibutton> button to update the |
---|
2704 | interface. If you want, you can fix more than one |
---|
2705 | failure before clicking on the button. |
---|
2706 | </simpara> |
---|
2707 | </listitem> |
---|
2708 | |
---|
2709 | </orderedlist> |
---|
2710 | |
---|
2711 | </helptext> |
---|
2712 | </sect2> |
---|
2713 | |
---|
2714 | </sect1> |
---|
2715 | |
---|
2716 | </chapter> |
---|