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

Last change on this file since 3394 was 3394, checked in by Martin Svensson, 15 years ago

Replaced the most common guibutton:s with entities

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