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

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

Reference #549. First revision of the whole chapter

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 29.1 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 3313 2007-05-09 11:22:17Z 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      <helptext external_id="user.edit" title="Edit user account">
70        <sect3 id="user_administration.users.edit.properties">
71          <title>Properties</title>
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        </sect3>
220        <para>
221          Go to the other tabs if there are any changes to do otherwise press
222          <guibutton>Save</guibutton>
223          to save the values or
224          <guibutton>Cancel</guibutton>
225          to abort.
226        </para>
227        <seeother>
228          <other external_id="user.edit.contact">Edit user's contact information</other>
229          <other external_id="user.edit.membership">Edit user's membership</other>
230        </seeother>
231      </helptext>
232      <helptext external_id="user.edit.contact" title="Edit user's contact information">
233        <sect3 id="user._administration.users.edit.contact">
234          <title>Contact information</title>
235          <para>
236            Information about how to get in contact with the user that is asocciated
237            with the account. All fields on this tab are optional and do not necessarily
238            need to have a value but some can be good to set, like email or phone
239            number.
240          </para>
241          <variablelist>
242            <varlistentry>
243              <term>
244                <optional>
245                  <guilabel>Email</guilabel>
246                </optional>
247              </term>
248              <listitem>
249                <para>
250                  User's email address. There is some verification of the value
251                  but there is no check if the email really exists.
252                </para>
253              </listitem>
254            </varlistentry>
255            <varlistentry>
256              <term>
257                <optional>
258                  <guilabel>Organization</guilabel>
259                </optional>
260              </term>
261              <listitem>
262                <para>The company or organization that the user works for.</para>
263              </listitem>
264            </varlistentry>
265            <varlistentry>
266              <term>
267                <optional>
268                  <guilabel>Address</guilabel>
269                </optional>
270              </term>
271              <listitem>
272                <para>
273                  User's mail address. Use the magnifying glass down to the right,
274                  to edit this property in a larger window.
275                </para>
276              </listitem>
277            </varlistentry>
278            <varlistentry>
279              <term>
280                <optional>
281                  <guilabel>Phone</guilabel>
282                </optional>
283              </term>
284              <listitem>
285                <para>
286                  User's phone number(s)
287                  <note>
288                    <para>
289                      There is no special field for mobile phone, but it works
290                      fine to put more then one number in this field.
291                    </para>
292                  </note>
293                </para>
294              </listitem>
295            </varlistentry>
296            <varlistentry>
297              <term>
298                <optional>
299                  <guilabel>Fax</guilabel>
300                </optional>
301              </term>
302              <listitem>
303                <para>User's fax number.</para>
304              </listitem>
305            </varlistentry>
306            <varlistentry>
307              <term>
308                <optional>
309                  <guilabel>Url</guilabel>
310                </optional>
311              </term>
312              <listitem>
313                <para>An URL that is associated with the user.</para>
314              </listitem>
315            </varlistentry>
316            <varlistentry>
317              <term>
318                <optional>
319                  <guilabel>Description</guilabel>
320                </optional>
321              </term>
322              <listitem>
323                <para>
324                  Other useful contact information or description about the user
325                  can be written in this field. Use the magnifying glass to edit
326                  the information in a pop-up window with a larger text-area.
327                </para>
328              </listitem>
329            </varlistentry>
330          </variablelist>
331        </sect3>
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
345      <helptext external_id="user.edit.membership" title="Edit user's membership">
346        <sect3 id="user_administration.users.edit.membership">
347          <title>User's membership</title>
348          <para>
349            An user's membership in groups and roles can be set on this tab. The
350            membership can also be changed by adding/removing the user to/from a
351            group's/role's list of members that is described in
352            <xref linkend="user_administration.groups.edit" />
353            and
354            <xref linkend="user_administration.roles.edit" />
355          </para>
356          <para>
357            Use
358            <guibutton>Add groups&hellip;</guibutton>
359            or
360            <guibutton>Add roles&hellip;</guibutton>
361            to add a membership in a group or a role. Mark the check-boxes for those
362            groups or roles that the user should become a member in. Using the
363            <guibutton>Ok</guibutton>
364            will add the selected items to the list of memberships.
365          </para>
366          <para>
367            Memberships are removed by selecting items from the list of memberships and
368            the pressing
369            <guibutton>Remove</guibutton>
370            . The selected items will then disappear from the list of memberships.
371          </para>
372        </sect3>
373        <para>
374          Go to the other tabs if there are any changes to do otherwise press
375          <guibutton>Save</guibutton>
376          to save the values or
377          <guibutton>Cancel</guibutton>
378          to abort.
379        </para>
380        <seeother>
381          <other external_id="user.edit">Edit account</other>
382          <other external_id="user.edit.contact">Edit user's contact information</other>
383        </seeother>
384      </helptext>
385    </sect2>
386  </sect1>
387
388  <sect1 id="user_administration.groups">
389    <title>Groups administration</title>
390    <para>
391      Groups in BASE are meant to represent physical groups that are working with the program.
392      It can be departments in an organization or some kind of lab teams, just to mention some
393      examples. An user's group-membership is normally set when the user is added to BASE and
394      has no needs to be changed later , except when the company is re-organizing.
395    </para>
396    <para>
397      There is one pre-installed group in BASE, a system group, called Everyone. It is, like
398      the name says, a group in which everyone(all users) are members. The users that are
399      allowed to share to everyone can easily share items to all users by sharing the item to
400      this group.
401    </para>
402
403    <sect2 id="user_administration.groups.edit">
404      <title>Edit group</title>
405      <para>
406        The pop-up window where a group can be edit has two tabs,
407        <guilabel>Group</guilabel>
408        and
409        <guilabel>Members</guilabel>
410      </para>
411      <helptext external_id="group.edit" title="Edit group">
412        <sect3 id="user_administration.groups.edit.properties">
413          <title>Properties</title>
414          <variablelist>
415            <varlistentry>
416              <term>
417                <guilabel>Name</guilabel>
418              </term>
419              <listitem>
420                <para>Group's name.(Required)</para>
421              </listitem>
422            </varlistentry>
423            <varlistentry>
424              <term>
425                <optional>
426                  <guilabel>Description</guilabel>
427                </optional>
428              </term>
429              <listitem>
430                <para>
431                  Description about the group. The magnifying glass, down to the
432                  right, can be used to open and edit the text in a larger text
433                  area.
434                </para>
435              </listitem>
436            </varlistentry>
437            <varlistentry>
438              <term>
439                <optional>
440                  <guilabel>Quota</guilabel>
441                </optional>
442              </term>
443              <listitem>
444                <para>
445                  With this property it's possible to limit the quota of total
446                  disc space for the group members. Select
447                  <guilabel>-none-</guilabel>
448                  from the drop-down list if the group shouldn't have any quota.
449                  There are some presets of quotas that comes with the BASE2
450                  installation, besides a couple with different size of total disc
451                  space there are one called
452                  <guilabel>No quota</guilabel>
453                  and one with
454                  <guilabel>Unlimited quota</guilabel>
455                  . Their names speak for them self.
456                </para>
457              </listitem>
458            </varlistentry>
459          </variablelist>
460        </sect3>
461        <para>
462          Go to the other tab,
463          <guilabel>Members</guilabel>
464          , if there are any changes to do otherwise use
465          <guibutton>Save</guibutton>
466          to save the settings or
467          <guibutton>Cancel</guibutton>
468          to abort.
469        </para>
470        <seeother>
471          <other external_id="group.edit.membership">Edit group members</other>
472        </seeother>
473      </helptext>
474
475      <helptext external_id="group.edit.membership" title="Edit group members">
476        <sect3 id="user_administration.groups.edit.members">
477          <title>Group members</title>
478          <para>
479            A group can have both single users and whole groups as members. Group
480            members have access to those items that are shared to the group. Each user
481            in the group has the possibility to share their own items to one or more of
482            the other members or to the whole group.
483          </para>
484          <para>
485            The list-box shows the group's members, both users and other groups.
486
487            Removing members from a group are done by first select one or several
488            members in the list and then click on
489            <guibutton>Remove</guibutton>
490            . The selected items will then disappear from the list.
491          </para>
492        </sect3>
493        <para>
494          Go to the other tab if there are any changes to do, otherwise use
495          <guibutton>Save</guibutton>
496          to save the values or
497          <guibutton>Cancel</guibutton>
498          to abort.
499        </para>
500        <seeother>
501          <other external_id="group.edit">Edit group properties</other>
502        </seeother>
503      </helptext>
504    </sect2>
505  </sect1>
506
507  <sect1 id="user_administration.roles">
508    <title>Roles administration</title>
509    <para>
510      Roles are different kinds of working positions that users can have, like server
511      administrator or regular user just to mention two. The permissions for a role are set
512      depending on what it is going to do in BASE.
513    </para>
514    <para>
515      Users are normally assigned a role, perhaps more then one, when they are created and
516      registered in BASE.
517    </para>
518
519    <sect2 id="user_administration.roles.edit">
520      <title>Edit role</title>
521      <para>
522        Creating a new role or editing the system-roles are something that don't needs to be
523        done very often. The existing roles will normally be enough but there can be some
524        cases when they need to be complemented, either with a new role or with different
525        permissions.
526      </para>
527      <helptext external_id="role.edit" title="Edit role">
528        <sect3 id="user_administration.roles.edit.properties">
529          <title>Properties</title>
530          <para>These are the properties that can be defined for a role.</para>
531          <variablelist>
532            <varlistentry>
533              <term>
534                <guilabel>Name</guilabel>
535              </term>
536              <listitem>
537                <para>The role's name. (Required)</para>
538              </listitem>
539            </varlistentry>
540            <varlistentry>
541              <term>
542                <guilabel>System-level permissions</guilabel>
543              </term>
544              <listitem>
545                <itemizedlist>
546                  <listitem>
547                    <simpara>
548                      With
549                      <guilabel>Share to Everyone</guilabel>
550                      set the role allows the user to share items to the
551                      system-group 'Everyone'.
552                    </simpara>
553                  </listitem>
554                  <listitem>
555                    <simpara>
556                      <guilabel>Act as another user</guilabel>
557                      - property makes it possible for the one with this role
558                      to login from the menu bar as another user. This is used
559                      by job agents when they should act as the user who
560                      created the job.
561                    </simpara>
562                  </listitem>
563                </itemizedlist>
564              </listitem>
565            </varlistentry>
566            <varlistentry>
567              <term>
568                <guilabel>Description</guilabel>
569              </term>
570              <listitem>
571                <para>Description and information about the role.(Optional)</para>
572              </listitem>
573            </varlistentry>
574          </variablelist>
575          <para>
576            Set the properties and proceed then to either one of the other tabs or by
577            clicking on one of the buttons:
578            <guibutton>Save</guibutton>
579            to save the changes or
580            <guibutton>Cancel</guibutton>
581            to abort.
582          </para>
583        </sect3>
584        <seeother>
585          <other external_id="role.edit.permissions">Role permissions</other>
586          <other external_id="role.edit.members">Role members</other>
587        </seeother>
588      </helptext>
589
590      <helptext external_id="role.edit.permissions" title="Edit role permissions">
591        <sect3 id="user_administration.roles.edit.permissions">
592          <title>Permissions</title>
593          <para>
594            A role's permissions are defined for each item type within BASE 2. Set the
595            role's permission on an item type by first selecting the item(s) in the list
596            and then tick those permissions that should be applied. Not all permissions
597            can be applied to every item type, that's why permission check-boxes becomes
598            disabled when selecting some of the item types
599          </para>
600          <para>
601            After each item type in the list is a string inside square brackets that
602            shows what kind of permissions the current role has on that particular item
603            type. The permissions that don't have been set are represented with '-'
604            inside the square brackets and those which have been set are represented
605            with characters that are listed below.
606          </para>
607          <itemizedlist>
608            <listitem>
609              <simpara>
610                <guilabel>DENIED</guilabel>
611                = Deny access to the selected item type. This exclude all the other
612                permissions by unchecking the other check boxes.
613              </simpara>
614            </listitem>
615            <listitem>
616              <simpara>
617                <guilabel>C</guilabel>
618                = Create
619              </simpara>
620            </listitem>
621            <listitem>
622              <simpara>
623                <guilabel>R</guilabel>
624                = Read
625              </simpara>
626            </listitem>
627            <listitem>
628              <simpara>
629                <guilabel>U</guilabel>
630                = Use
631              </simpara>
632            </listitem>
633            <listitem>
634              <simpara>
635                <guilabel>W</guilabel>
636                = Write
637              </simpara>
638            </listitem>
639            <listitem>
640              <simpara>
641                <guilabel>D</guilabel>
642                = Delete
643              </simpara>
644            </listitem>
645            <listitem>
646              <simpara>
647                <guilabel>O</guilabel>
648                = Take ownership
649              </simpara>
650            </listitem>
651            <listitem>
652              <simpara>
653                <guilabel>P</guilabel>
654                = Set permission
655              </simpara>
656            </listitem>
657          </itemizedlist>
658          <para>
659            Set the role's permission on each one of the item types and proceed then to
660            one of the other tabs or click on one of the buttons:
661            <guibutton>Save</guibutton>
662            to save the changes or
663            <guibutton>Cancel</guibutton>
664            to abort.
665          </para>
666        </sect3>
667        <seeother>
668          <other external_id="role.edit">Edit properties</other>
669          <other external_id="role.edit.members">Role members</other>
670        </seeother>
671      </helptext>
672
673      <helptext external_id="role.edit.members" title="Role members">
674        <sect3 id="user_administration.roles.edit.members">
675          <title>Members</title>
676          <para>
677            Users that are members of a role are listed in the list-box located on this
678            tab. Members can be added or removed with the two buttons, located to the
679            right of the list box,
680            <guibutton>Add users&hellip;</guibutton>
681            and
682            <guibutton>Remove</guibutton>
683            .
684          </para>
685          <variablelist>
686            <varlistentry>
687              <term>Add users to list</term>
688              <listitem>
689                <para>
690                  Click on
691                  <guibutton>Add users&hellip;</guibutton>
692                  and select the users that should be added from the list in the
693                  pop-up window. Press then on the
694                  <guibutton>Ok</guibutton>
695                  button to close the pop-up window and add the selected users.
696                  Use
697                  <guibutton>Cancel</guibutton>
698                  or just close the pop-up to abort and return to main window.
699                </para>
700              </listitem>
701            </varlistentry>
702            <varlistentry>
703              <term>Remove users from list</term>
704              <listitem>
705                <para>
706                  Members are removed from the list by first selecting them and
707                  then pressing
708                  <guibutton>Remove</guibutton>
709                  . The selected user(s) are removed immediately.
710                </para>
711              </listitem>
712            </varlistentry>
713          </variablelist>
714          <para>
715            Press
716            <guibutton>Save</guibutton>
717            to save the role or go to one of the other tabs if there are more that needs
718            to be set. Use
719            <guibutton>Close</guibutton>
720            to abort and close the window without saving the changes.
721          </para>
722        </sect3>
723        <seeother>
724          <other external_id="role.edit">Edit properties</other>
725          <other external_id="role.edit.permissions">Role permissions</other>
726        </seeother>
727      </helptext>
728    </sect2>
729
730    <sect2 id="user_administration.roles.defaultroles">
731      <title>Default roles</title>
732      <para>
733        There are some default roles that come with BASE2. These are configured to cover the
734        normal user roles that can appear. A more detailed description of the different
735        roles and when to use them follows here.
736      </para>
737      <variablelist>
738        <varlistentry>
739          <term>Administrator</term>
740          <listitem>
741            <para>
742              This role gives the user full permission to do everything in BASE and
743              also possibility to share items with the system-group 'Everyone'. Users
744              that are supposed to administrate the server, user accounts, groups etc.
745              should have this role.
746            </para>
747          </listitem>
748        </varlistentry>
749        <varlistentry>
750          <term>Supervisor</term>
751          <listitem>
752            <para>
753              Users that are members of this role has permission to read everything in
754              BASE. This role doesn't let the members to actually do anything in BASE
755              except read and supervise.
756            </para>
757          </listitem>
758        </varlistentry>
759        <varlistentry>
760          <term>Power user</term>
761          <listitem>
762            <para>
763              This role allows it's members to do some things that an ordinary user
764              not is allowed to. This role can be proper for those users that are in
765              some kind of leading position over workgroups or projects.
766            </para>
767          </listitem>
768        </varlistentry>
769        <varlistentry>
770          <term>User</term>
771          <listitem>
772            <para>
773              A role that is suitable for all ordinary users. This allows the members
774              to do common things in BASE as analysis, creating biomaterials and
775              experiments and so on.
776            </para>
777          </listitem>
778        </varlistentry>
779        <varlistentry>
780          <term>Guest</term>
781          <listitem>
782            <para>
783              This is a role with limited access to create new things. It is useful
784              for those who wants to have peek at the program.
785            </para>
786          </listitem>
787        </varlistentry>
788        <varlistentry>
789          <term>Job agent</term>
790          <listitem>
791            <para>
792              This role is given to the job agents and allows them to read and execute
793              jobs. Job agents always runs the jobs as the user who created the job
794              and therefore it have to be able to act as another user. No more
795              permissions then these are needed for job agents.
796            </para>
797          </listitem>
798        </varlistentry>
799      </variablelist>
800    </sect2>
801  </sect1>
802
803  <sect1 id="user_administration.quota">
804    <title>Disc space/quota</title>
805    <para>
806      The administrator can control the maximum size of disc space that each user should be
807      able to use. Also groups can have limited disc quota and this will effect when an user,
808      that is member of a quota group, is saving something to the database that is disc
809      consuming. The most restricted one of the group's quota and user's quota will be used
810      and the user will be denied to store the item on the server if one of the disc quotas is
811      filled.
812    </para>
813    <para>
814      How to set an user's quota or to create a quota can be read at
815      <xref linkend="user_administration.groups.edit" />
816      and
817      <xref linkend="user_administration.users.edit" />
818    </para>
819    <para>
820      The list of quotas in BASE can be found by using the menu
821      <menuchoice>
822        <guimenu>Administrate</guimenu>
823        <guimenuitem>Quota</guimenuitem>
824      </menuchoice>
825      .
826    </para>
827
828    <sect2 id="user_administration.quota.edit">
829      <title>Edit quota</title>
830      <para>
831        The edit window has two tabs, one with information about the quota and one where the
832        limits are defined.
833      </para>
834      <helptext external_id="quota.edit" title="Edit properties">
835        <sect3 id="user_administration.quota.edit.properties">
836          <title>Properties</title>
837          <variablelist>
838            <varlistentry>
839              <term>
840                <guilabel>Name</guilabel>
841              </term>
842              <listitem>
843                <para>Name of the quota (Required).</para>
844              </listitem>
845            </varlistentry>
846            <varlistentry>
847              <term>
848                <optional>
849                  <guilabel>Description</guilabel>
850                </optional>
851              </term>
852              <listitem>
853                <para>
854                  Description of the quota. It could be a good idea to
855                  describe the quota's details here. Use the magnifying glass to
856                  edit the text in a larger text area.(Optional)
857                </para>
858              </listitem>
859            </varlistentry>
860          </variablelist>
861          <para>
862            Go to the other tab if there are values that haven't been set. Otherwise use
863            <guibutton>Save</guibutton>
864            to save the settings or
865            <guibutton>Cancel</guibutton>
866            to abort.
867          </para>
868        </sect3>
869      </helptext>
870
871      <helptext external_id="quota.edit.values" title="Edit values">
872        <sect3 id="user_administration.quota.edit.values">
873          <title>Values</title>
874          <para>
875            The quota values are defined here, both for the primary location and the
876            secondary location. Use the check box to the right of the input fields to
877            set unlimited quota.
878          </para>
879          <variablelist>
880            <varlistentry>
881              <term>
882                <guilabel>Total</guilabel>
883              </term>
884              <listitem>
885                <para>
886                  Limit of total quota. The sum of the other three quotas doesn't
887                  have to be the same as this, it is always the most restricted
888                  value that is used.(Required)
889                </para>
890              </listitem>
891            </varlistentry>
892            <varlistentry>
893              <term>
894                <optional>
895                  <guilabel>Files</guilabel>
896                </optional>
897              </term>
898              <listitem>
899                <para>Limit of disc space to save files in.(Optional)</para>
900              </listitem>
901            </varlistentry>
902            <varlistentry>
903              <term>
904                <optional>
905                  <guilabel>Raw data</guilabel>
906                </optional>
907              </term>
908              <listitem>
909                <para>disc space to save Raw data in.(Optional)</para>
910              </listitem>
911            </varlistentry>
912            <varlistentry>
913              <term>
914                <optional>
915                  <guilabel>Experiments</guilabel>
916                </optional>
917              </term>
918              <listitem>
919                <para>
920                  Limit of disc space that can be used by experiments.(Optional)
921                </para>
922              </listitem>
923            </varlistentry>
924          </variablelist>
925          <para>
926            When everything have been set the quota is saved by using
927            <guibutton>Save</guibutton>
928            . To discard changes use
929            <guibutton>Cancel</guibutton>
930            .
931          </para>
932        </sect3>
933      </helptext>
934    </sect2>
935  </sect1>
936</chapter>
Note: See TracBrowser for help on using the repository browser.