source: trunk/doc/src/docbook/admindoc/user_administration.xml @ 3326

Last change on this file since 3326 was 3326, checked in by Martin Svensson, 14 years ago

References #549. Moved the helptext-tags inside the sect3-tags to avoid strange behavior in webclient.
Also defined a style for 'tip' in helptexts.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 29.2 KB
Line 
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: user_administration.xml 3326 2007-05-11 10:04:01Z martin $
7
8  Copyright (C) Authors contributing to this file.
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 2
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 this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330,
26  Boston, MA  02111-1307, USA.
27-->
28
29<chapter id="user_administration">
30  <?dbhtml dir="user_administration"?>
31  <title>Account administration</title>
32
33  <sect1 id="user_administration.permissions">
34    <title>Permission system</title>
35    <para>
36      Users get their general permissions from the role they belong to and more item specific
37      permissions from shared items in groups and projects they are members in. An user has
38      always full permissions on it's own items.
39    </para>
40    <para>
41      As an administrator you only have to think of what kinds of tasks an user is going to
42      work with and give he/she the appropriate role for that. The rest of the permissions
43      should the user normally get from the projects he/she is a member in.
44    </para>
45    <para>
46      More information about the permission system and working with projects can be found in
47      <xref linkend="project_permission" />
48    </para>
49  </sect1>
50
51  <sect1 id="user_administration.users">
52    <title>Users administration</title>
53    <para>
54      The user list is accessed with
55      <menuchoice>
56        <guimenu>Administrate</guimenu>
57        <guimenuitem>Users</guimenuitem>
58      </menuchoice>
59      and from here are the users' account and contact information managed.
60    </para>
61
62    <sect2 id="user_administration.users.edit">
63      <title>Edit user</title>
64      <para>
65        The pop-up window where information and settings for an user can be edit has three
66        tabs, one for the account related, one with information about the user and one that
67        shows the user's memberships.
68      </para>
69      <sect3 id="user_administration.users.edit.properties">       
70          <title>Properties</title>
71          <helptext external_id="user.edit" title="Edit user account">
72          <para>These are the properties for an user account.</para>
73          <variablelist>
74            <varlistentry>
75              <term>
76                <guilabel>Name</guilabel>
77              </term>
78              <listitem>
79                <para>
80                  The full name of the user that is associated with the account.
81                  (Required)
82                </para>
83              </listitem>
84            </varlistentry>
85            <varlistentry>
86              <term>
87                <guilabel>Login</guilabel>
88              </term>
89              <listitem>
90                <para>
91                  A login name to use when logging in to the account. (Required)
92                </para>
93              </listitem>
94            </varlistentry>
95            <varlistentry>
96              <term>
97                <optional>
98                  <guilabel>External ID</guilabel>
99                </optional>
100              </term>
101              <listitem>
102                <para>
103                  An id that is used to identify the user outside BASE. (Optional)
104                </para>
105              </listitem>
106            </varlistentry>
107            <varlistentry>
108              <term>
109                <guilabel>New password</guilabel>
110              </term>
111              <listitem>
112                <para>
113                  This is used together with the login name to log in to the
114                  account. This is a required field for a new user or if the
115                  password should be changed. If the field is left empty the
116                  password will be unchanged
117                </para>
118              </listitem>
119            </varlistentry>
120            <varlistentry>
121              <term>
122                <guilabel>Retype password</guilabel>
123              </term>
124              <listitem>
125                <para>
126                  Retype the password that is written in
127                  <guilabel>New password</guilabel>
128                  .
129                </para>
130              </listitem>
131            </varlistentry>
132            <varlistentry>
133              <term>
134                <optional>
135                  <guilabel>Quota</guilabel>
136                </optional>
137              </term>
138              <listitem>
139                <para>Set disc quota for the account.(Required)</para>
140              </listitem>
141            </varlistentry>
142            <varlistentry>
143              <term>
144                <optional>
145                  <guilabel>Quota group</guilabel>
146                </optional>
147              </term>
148              <listitem>
149                <para>
150                  Set this if the account should belong to a group with specified
151                  quota. With this set the user's possibilities to save items to
152                  disc will also depend on how much the rest of the group has
153                  saved.(Optional)
154                </para>
155              </listitem>
156            </varlistentry>
157            <varlistentry>
158              <term>
159                <optional>
160                  <guilabel>Home directory</guilabel>
161                </optional>
162              </term>
163              <listitem>
164                <para>
165                  Set the account's home directory. A new directory, either empty
166                  or from a template, can be created if editing a new user. Select
167                  <guilabel>- none -</guilabel>
168                  if there shouldn't be any home directory asocciated with the
169                  account.(Optional)
170                </para>
171              </listitem>
172            </varlistentry>
173            <varlistentry>
174              <term>
175                <optional>
176                  <guilabel>Expiration date</guilabel>
177                </optional>
178              </term>
179              <listitem>
180                <para>
181                  Define a date in this field if the account should expire on a
182                  certain day. The account will be disabled after this date. Leave
183                  this empty if the account should be continuous. (Optional)
184                  <tip>
185                    <para>
186                      Use
187                      <guibutton>Calendar&hellip;</guibutton>
188                      to pick a date from a calendar in a pop-up window.
189                    </para>
190                  </tip>
191                </para>
192              </listitem>
193            </varlistentry>
194            <varlistentry>
195              <term>
196                <guilabel>Multi-user account</guilabel>
197              </term>
198              <listitem>
199                <para>
200                  This checkbox should be checked if the account should be used by
201                  more one user. It will block the users of the account to change
202                  password, contact information and other settings that will mess
203                  up the use of the account.
204                </para>
205              </listitem>
206            </varlistentry>
207            <varlistentry>
208              <term>
209                <guilabel>Disabled</guilabel>
210              </term>
211              <listitem>
212                <para>
213                  Disable the account for further use by check this. The account
214                  can't be used until this is unchecked.
215                </para>
216              </listitem>
217            </varlistentry>
218          </variablelist>
219          <para>
220            Go to the other tabs if there are any changes to do otherwise press
221            <guibutton>Save</guibutton>
222            to save the values or
223            <guibutton>Cancel</guibutton>
224            to abort.
225          </para>
226          <seeother>
227            <other external_id="user.edit.contact">Edit user's contact information</other>
228            <other external_id="user.edit.membership">Edit user's membership</other>
229          </seeother>
230        </helptext>
231      </sect3>
232
233      <sect3 id="user._administration.users.edit.contact">
234        <title>Contact information</title>
235        <helptext external_id="user.edit.contact" title="Edit user's contact information">
236          <para>
237            Information about how to get in contact with the user that is asocciated
238            with the account. All fields on this tab are optional and do not necessarily
239            need to have a value but some can be good to set, like email or phone
240            number.
241          </para>
242          <variablelist>
243            <varlistentry>
244              <term>
245                <optional>
246                  <guilabel>Email</guilabel>
247                </optional>
248              </term>
249              <listitem>
250                <para>
251                  User's email address. There is some verification of the value
252                  but there is no check if the email really exists.
253                </para>
254              </listitem>
255            </varlistentry>
256            <varlistentry>
257              <term>
258                <optional>
259                  <guilabel>Organization</guilabel>
260                </optional>
261              </term>
262              <listitem>
263                <para>The company or organization that the user works for.</para>
264              </listitem>
265            </varlistentry>
266            <varlistentry>
267              <term>
268                <optional>
269                  <guilabel>Address</guilabel>
270                </optional>
271              </term>
272              <listitem>
273                <para>
274                  User's mail address. Use the magnifying glass down to the right,
275                  to edit this property in a larger window.
276                </para>
277              </listitem>
278            </varlistentry>
279            <varlistentry>
280              <term>
281                <optional>
282                  <guilabel>Phone</guilabel>
283                </optional>
284              </term>
285              <listitem>
286                <para>
287                  User's phone number(s)
288                  <note>
289                    <para>
290                      There is no special field for mobile phone, but it works
291                      fine to put more then one number in this field.
292                    </para>
293                  </note>
294                </para>
295              </listitem>
296            </varlistentry>
297            <varlistentry>
298              <term>
299                <optional>
300                  <guilabel>Fax</guilabel>
301                </optional>
302              </term>
303              <listitem>
304                <para>User's fax number.</para>
305              </listitem>
306            </varlistentry>
307            <varlistentry>
308              <term>
309                <optional>
310                  <guilabel>Url</guilabel>
311                </optional>
312              </term>
313              <listitem>
314                <para>An URL that is associated with the user.</para>
315              </listitem>
316            </varlistentry>
317            <varlistentry>
318              <term>
319                <optional>
320                  <guilabel>Description</guilabel>
321                </optional>
322              </term>
323              <listitem>
324                <para>
325                  Other useful contact information or description about the user
326                  can be written in this field. Use the magnifying glass to edit
327                  the information in a pop-up window with a larger text-area.
328                </para>
329              </listitem>
330            </varlistentry>
331          </variablelist>
332          <para>
333            Go to the other tabs if there are any changes to do otherwise press
334            <guibutton>Save</guibutton>
335            to save the values or
336            <guibutton>Cancel</guibutton>
337            to abort.
338          </para>
339          <seeother>
340            <other external_id="user.edit">Edit account</other>
341            <other external_id="user.edit.membership">Edit user's membership</other>
342          </seeother>
343        </helptext>
344      </sect3>
345
346
347      <sect3 id="user_administration.users.edit.membership">
348        <title>User's membership</title>
349        <helptext external_id="user.edit.membership" title="Edit user's membership">
350          <para>
351            An user's membership in groups and roles can be set on this tab. The
352            membership can also be changed by adding/removing the user to/from a
353            group's/role's list of members that is described in
354            <xref linkend="user_administration.groups.edit" />
355            and
356            <xref linkend="user_administration.roles.edit" />
357          </para>
358          <para>
359            Use
360            <guibutton>Add groups&hellip;</guibutton>
361            or
362            <guibutton>Add roles&hellip;</guibutton>
363            to add a membership in a group or a role. Mark the check-boxes for those
364            groups or roles that the user should become a member in. Using the
365            <guibutton>Ok</guibutton>
366            will add the selected items to the list of memberships.
367          </para>
368          <para>
369            Memberships are removed by selecting items from the list of memberships and
370            the pressing
371            <guibutton>Remove</guibutton>
372            . The selected items will then disappear from the list of memberships.
373          </para>
374          <para>
375            Go to the other tabs if there are any changes to do otherwise press
376            <guibutton>Save</guibutton>
377            to save the values or
378            <guibutton>Cancel</guibutton>
379            to abort.
380          </para>
381          <seeother>
382            <other external_id="user.edit">Edit account</other>
383            <other external_id="user.edit.contact">
384              Edit user's contact information
385            </other>
386          </seeother>
387        </helptext>
388      </sect3>
389    </sect2>
390  </sect1>
391
392  <sect1 id="user_administration.groups">
393    <title>Groups administration</title>
394    <para>
395      Groups in BASE are meant to represent physical groups that are working with the program.
396      It can be departments in an organization or some kind of lab teams, just to mention some
397      examples. An user's group-membership is normally set when the user is added to BASE and
398      has no needs to be changed later , except when the company is re-organizing.
399    </para>
400    <para>
401      There is one pre-installed group in BASE, a system group, called Everyone. It is, like
402      the name says, a group in which everyone(all users) are members. The users that are
403      allowed to share to everyone can easily share items to all users by sharing the item to
404      this group.
405    </para>
406
407    <sect2 id="user_administration.groups.edit">
408      <title>Edit group</title>
409      <para>
410        The pop-up window where a group can be edit has two tabs,
411        <guilabel>Group</guilabel>
412        and
413        <guilabel>Members</guilabel>
414      </para>
415      <helptext external_id="group.edit" title="Edit group">
416        <sect3 id="user_administration.groups.edit.properties">
417          <title>Properties</title>
418          <variablelist>
419            <varlistentry>
420              <term>
421                <guilabel>Name</guilabel>
422              </term>
423              <listitem>
424                <para>Group's name.(Required)</para>
425              </listitem>
426            </varlistentry>
427            <varlistentry>
428              <term>
429                <optional>
430                  <guilabel>Description</guilabel>
431                </optional>
432              </term>
433              <listitem>
434                <para>
435                  Description about the group. The magnifying glass, down to the
436                  right, can be used to open and edit the text in a larger text
437                  area.
438                </para>
439              </listitem>
440            </varlistentry>
441            <varlistentry>
442              <term>
443                <optional>
444                  <guilabel>Quota</guilabel>
445                </optional>
446              </term>
447              <listitem>
448                <para>
449                  With this property it's possible to limit the quota of total
450                  disc space for the group members. Select
451                  <guilabel>-none-</guilabel>
452                  from the drop-down list if the group shouldn't have any quota.
453                  There are some presets of quotas that comes with the BASE2
454                  installation, besides a couple with different size of total disc
455                  space there are one called
456                  <guilabel>No quota</guilabel>
457                  and one with
458                  <guilabel>Unlimited quota</guilabel>
459                  . Their names speak for them self.
460                </para>
461              </listitem>
462            </varlistentry>
463          </variablelist>
464        </sect3>
465        <para>
466          Go to the other tab,
467          <guilabel>Members</guilabel>
468          , if there are any changes to do otherwise use
469          <guibutton>Save</guibutton>
470          to save the settings or
471          <guibutton>Cancel</guibutton>
472          to abort.
473        </para>
474        <seeother>
475          <other external_id="group.edit.membership">Edit group members</other>
476        </seeother>
477      </helptext>
478
479      <helptext external_id="group.edit.membership" title="Edit group members">
480        <sect3 id="user_administration.groups.edit.members">
481          <title>Group members</title>
482          <para>
483            A group can have both single users and whole groups as members. Group
484            members have access to those items that are shared to the group. Each user
485            in the group has the possibility to share their own items to one or more of
486            the other members or to the whole group.
487          </para>
488          <para>
489            The list-box shows the group's members, both users and other groups.
490
491            Removing members from a group are done by first select one or several
492            members in the list and then click on
493            <guibutton>Remove</guibutton>
494            . The selected items will then disappear from the list.
495          </para>
496        </sect3>
497        <para>
498          Go to the other tab if there are any changes to do, otherwise use
499          <guibutton>Save</guibutton>
500          to save the values or
501          <guibutton>Cancel</guibutton>
502          to abort.
503        </para>
504        <seeother>
505          <other external_id="group.edit">Edit group properties</other>
506        </seeother>
507      </helptext>
508    </sect2>
509  </sect1>
510
511  <sect1 id="user_administration.roles">
512    <title>Roles administration</title>
513    <para>
514      Roles are different kinds of working positions that users can have, like server
515      administrator or regular user just to mention two. The permissions for a role are set
516      depending on what it is going to do in BASE.
517    </para>
518    <para>
519      Users are normally assigned a role, perhaps more then one, when they are created and
520      registered in BASE.
521    </para>
522
523    <sect2 id="user_administration.roles.edit">
524      <title>Edit role</title>
525      <para>
526        Creating a new role or editing the system-roles are something that don't needs to be
527        done very often. The existing roles will normally be enough but there can be some
528        cases when they need to be complemented, either with a new role or with different
529        permissions.
530      </para>
531      <helptext external_id="role.edit" title="Edit role">
532        <sect3 id="user_administration.roles.edit.properties">
533          <title>Properties</title>
534          <para>These are the properties that can be defined for a role.</para>
535          <variablelist>
536            <varlistentry>
537              <term>
538                <guilabel>Name</guilabel>
539              </term>
540              <listitem>
541                <para>The role's name. (Required)</para>
542              </listitem>
543            </varlistentry>
544            <varlistentry>
545              <term>
546                <guilabel>System-level permissions</guilabel>
547              </term>
548              <listitem>
549                <itemizedlist>
550                  <listitem>
551                    <simpara>
552                      With
553                      <guilabel>Share to Everyone</guilabel>
554                      set the role allows the user to share items to the
555                      system-group 'Everyone'.
556                    </simpara>
557                  </listitem>
558                  <listitem>
559                    <simpara>
560                      <guilabel>Act as another user</guilabel>
561                      - property makes it possible for the one with this role
562                      to login from the menu bar as another user. This is used
563                      by job agents when they should act as the user who
564                      created the job.
565                    </simpara>
566                  </listitem>
567                </itemizedlist>
568              </listitem>
569            </varlistentry>
570            <varlistentry>
571              <term>
572                <guilabel>Description</guilabel>
573              </term>
574              <listitem>
575                <para>Description and information about the role.(Optional)</para>
576              </listitem>
577            </varlistentry>
578          </variablelist>
579          <para>
580            Set the properties and proceed then to either one of the other tabs or by
581            clicking on one of the buttons:
582            <guibutton>Save</guibutton>
583            to save the changes or
584            <guibutton>Cancel</guibutton>
585            to abort.
586          </para>
587        </sect3>
588        <seeother>
589          <other external_id="role.edit.permissions">Role permissions</other>
590          <other external_id="role.edit.members">Role members</other>
591        </seeother>
592      </helptext>
593
594      <helptext external_id="role.edit.permissions" title="Edit role permissions">
595        <sect3 id="user_administration.roles.edit.permissions">
596          <title>Permissions</title>
597          <para>
598            A role's permissions are defined for each item type within BASE 2. Set the
599            role's permission on an item type by first selecting the item(s) in the list
600            and then tick those permissions that should be applied. Not all permissions
601            can be applied to every item type, that's why permission check-boxes becomes
602            disabled when selecting some of the item types
603          </para>
604          <para>
605            After each item type in the list is a string inside square brackets that
606            shows what kind of permissions the current role has on that particular item
607            type. The permissions that don't have been set are represented with '-'
608            inside the square brackets and those which have been set are represented
609            with characters that are listed below.
610          </para>
611          <itemizedlist>
612            <listitem>
613              <simpara>
614                <guilabel>DENIED</guilabel>
615                = Deny access to the selected item type. This exclude all the other
616                permissions by unchecking the other check boxes.
617              </simpara>
618            </listitem>
619            <listitem>
620              <simpara>
621                <guilabel>C</guilabel>
622                = Create
623              </simpara>
624            </listitem>
625            <listitem>
626              <simpara>
627                <guilabel>R</guilabel>
628                = Read
629              </simpara>
630            </listitem>
631            <listitem>
632              <simpara>
633                <guilabel>U</guilabel>
634                = Use
635              </simpara>
636            </listitem>
637            <listitem>
638              <simpara>
639                <guilabel>W</guilabel>
640                = Write
641              </simpara>
642            </listitem>
643            <listitem>
644              <simpara>
645                <guilabel>D</guilabel>
646                = Delete
647              </simpara>
648            </listitem>
649            <listitem>
650              <simpara>
651                <guilabel>O</guilabel>
652                = Take ownership
653              </simpara>
654            </listitem>
655            <listitem>
656              <simpara>
657                <guilabel>P</guilabel>
658                = Set permission
659              </simpara>
660            </listitem>
661          </itemizedlist>
662          <para>
663            Set the role's permission on each one of the item types and proceed then to
664            one of the other tabs or click on one of the buttons:
665            <guibutton>Save</guibutton>
666            to save the changes or
667            <guibutton>Cancel</guibutton>
668            to abort.
669          </para>
670        </sect3>
671        <seeother>
672          <other external_id="role.edit">Edit properties</other>
673          <other external_id="role.edit.members">Role members</other>
674        </seeother>
675      </helptext>
676
677      <helptext external_id="role.edit.members" title="Role members">
678        <sect3 id="user_administration.roles.edit.members">
679          <title>Members</title>
680          <para>
681            Users that are members of a role are listed in the list-box located on this
682            tab. Members can be added or removed with the two buttons, located to the
683            right of the list box,
684            <guibutton>Add users&hellip;</guibutton>
685            and
686            <guibutton>Remove</guibutton>
687            .
688          </para>
689          <variablelist>
690            <varlistentry>
691              <term>Add users to list</term>
692              <listitem>
693                <para>
694                  Click on
695                  <guibutton>Add users&hellip;</guibutton>
696                  and select the users that should be added from the list in the
697                  pop-up window. Press then on the
698                  <guibutton>Ok</guibutton>
699                  button to close the pop-up window and add the selected users.
700                  Use
701                  <guibutton>Cancel</guibutton>
702                  or just close the pop-up to abort and return to main window.
703                </para>
704              </listitem>
705            </varlistentry>
706            <varlistentry>
707              <term>Remove users from list</term>
708              <listitem>
709                <para>
710                  Members are removed from the list by first selecting them and
711                  then pressing
712                  <guibutton>Remove</guibutton>
713                  . The selected user(s) are removed immediately.
714                </para>
715              </listitem>
716            </varlistentry>
717          </variablelist>
718          <para>
719            Press
720            <guibutton>Save</guibutton>
721            to save the role or go to one of the other tabs if there are more that needs
722            to be set. Use
723            <guibutton>Close</guibutton>
724            to abort and close the window without saving the changes.
725          </para>
726        </sect3>
727        <seeother>
728          <other external_id="role.edit">Edit properties</other>
729          <other external_id="role.edit.permissions">Role permissions</other>
730        </seeother>
731      </helptext>
732    </sect2>
733
734    <sect2 id="user_administration.roles.defaultroles">
735      <title>Default roles</title>
736      <para>
737        There are some default roles that come with BASE2. These are configured to cover the
738        normal user roles that can appear. A more detailed description of the different
739        roles and when to use them follows here.
740      </para>
741      <variablelist>
742        <varlistentry>
743          <term>Administrator</term>
744          <listitem>
745            <para>
746              This role gives the user full permission to do everything in BASE and
747              also possibility to share items with the system-group 'Everyone'. Users
748              that are supposed to administrate the server, user accounts, groups etc.
749              should have this role.
750            </para>
751          </listitem>
752        </varlistentry>
753        <varlistentry>
754          <term>Supervisor</term>
755          <listitem>
756            <para>
757              Users that are members of this role has permission to read everything in
758              BASE. This role doesn't let the members to actually do anything in BASE
759              except read and supervise.
760            </para>
761          </listitem>
762        </varlistentry>
763        <varlistentry>
764          <term>Power user</term>
765          <listitem>
766            <para>
767              This role allows it's members to do some things that an ordinary user
768              not is allowed to. This role can be proper for those users that are in
769              some kind of leading position over workgroups or projects.
770            </para>
771          </listitem>
772        </varlistentry>
773        <varlistentry>
774          <term>User</term>
775          <listitem>
776            <para>
777              A role that is suitable for all ordinary users. This allows the members
778              to do common things in BASE as analysis, creating biomaterials and
779              experiments and so on.
780            </para>
781          </listitem>
782        </varlistentry>
783        <varlistentry>
784          <term>Guest</term>
785          <listitem>
786            <para>
787              This is a role with limited access to create new things. It is useful
788              for those who wants to have peek at the program.
789            </para>
790          </listitem>
791        </varlistentry>
792        <varlistentry>
793          <term>Job agent</term>
794          <listitem>
795            <para>
796              This role is given to the job agents and allows them to read and execute
797              jobs. Job agents always runs the jobs as the user who created the job
798              and therefore it have to be able to act as another user. No more
799              permissions then these are needed for job agents.
800            </para>
801          </listitem>
802        </varlistentry>
803      </variablelist>
804    </sect2>
805  </sect1>
806
807  <sect1 id="user_administration.quota">
808    <title>Disc space/quota</title>
809    <para>
810      The administrator can control the maximum size of disc space that each user should be
811      able to use. Also groups can have limited disc quota and this will effect when an user,
812      that is member of a quota group, is saving something to the database that is disc
813      consuming. The most restricted one of the group's quota and user's quota will be used
814      and the user will be denied to store the item on the server if one of the disc quotas is
815      filled.
816    </para>
817    <para>
818      How to set an user's quota or to create a quota can be read at
819      <xref linkend="user_administration.groups.edit" />
820      and
821      <xref linkend="user_administration.users.edit" />
822    </para>
823    <para>
824      The list of quotas in BASE can be found by using the menu
825      <menuchoice>
826        <guimenu>Administrate</guimenu>
827        <guimenuitem>Quota</guimenuitem>
828      </menuchoice>
829      .
830    </para>
831
832    <sect2 id="user_administration.quota.edit">
833      <title>Edit quota</title>
834      <para>
835        The edit window has two tabs, one with information about the quota and one where the
836        limits are defined.
837      </para>
838      <helptext external_id="quota.edit" title="Edit properties">
839        <sect3 id="user_administration.quota.edit.properties">
840          <title>Properties</title>
841          <variablelist>
842            <varlistentry>
843              <term>
844                <guilabel>Name</guilabel>
845              </term>
846              <listitem>
847                <para>Name of the quota (Required).</para>
848              </listitem>
849            </varlistentry>
850            <varlistentry>
851              <term>
852                <optional>
853                  <guilabel>Description</guilabel>
854                </optional>
855              </term>
856              <listitem>
857                <para>
858                  Description of the quota. It could be a good idea to
859                  describe the quota's details here. Use the magnifying glass to
860                  edit the text in a larger text area.(Optional)
861                </para>
862              </listitem>
863            </varlistentry>
864          </variablelist>
865          <para>
866            Go to the other tab if there are values that haven't been set. Otherwise use
867            <guibutton>Save</guibutton>
868            to save the settings or
869            <guibutton>Cancel</guibutton>
870            to abort.
871          </para>
872        </sect3>
873      </helptext>
874
875      <helptext external_id="quota.edit.values" title="Edit values">
876        <sect3 id="user_administration.quota.edit.values">
877          <title>Values</title>
878          <para>
879            The quota values are defined here, both for the primary location and the
880            secondary location. Use the check box to the right of the input fields to
881            set unlimited quota.
882          </para>
883          <variablelist>
884            <varlistentry>
885              <term>
886                <guilabel>Total</guilabel>
887              </term>
888              <listitem>
889                <para>
890                  Limit of total quota. The sum of the other three quotas doesn't
891                  have to be the same as this, it is always the most restricted
892                  value that is used.(Required)
893                </para>
894              </listitem>
895            </varlistentry>
896            <varlistentry>
897              <term>
898                <optional>
899                  <guilabel>Files</guilabel>
900                </optional>
901              </term>
902              <listitem>
903                <para>Limit of disc space to save files in.(Optional)</para>
904              </listitem>
905            </varlistentry>
906            <varlistentry>
907              <term>
908                <optional>
909                  <guilabel>Raw data</guilabel>
910                </optional>
911              </term>
912              <listitem>
913                <para>disc space to save Raw data in.(Optional)</para>
914              </listitem>
915            </varlistentry>
916            <varlistentry>
917              <term>
918                <optional>
919                  <guilabel>Experiments</guilabel>
920                </optional>
921              </term>
922              <listitem>
923                <para>
924                  Limit of disc space that can be used by experiments.(Optional)
925                </para>
926              </listitem>
927            </varlistentry>
928          </variablelist>
929          <para>
930            When everything have been set the quota is saved by using
931            <guibutton>Save</guibutton>
932            . To discard changes use
933            <guibutton>Cancel</guibutton>
934            .
935          </para>
936        </sect3>
937      </helptext>
938    </sect2>
939  </sect1>
940</chapter>
Note: See TracBrowser for help on using the repository browser.