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

Last change on this file since 3487 was 3487, checked in by Peter Johansson, 15 years ago

added end-of-line style property and replaced don't and similiar with do not and corresponding expression

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 34.5 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 3487 2007-06-13 17:56:05Z peter $
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 should not 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      <sect3 id="user_administration.users.edit.membership">
340        <title>Group and role membership</title>
341        <helptext external_id="user.edit.membership" title="Group and role membership">
342          <para>
343            On this tab, the group and role membership of a user can be
344            specified. The membership can also be changed by editing the
345            group and/or role.
346           
347            <note>
348              <para>
349              When adding a new user, the user is automatically added
350              as a member to all groups and roles that has been marked
351              as <emphasis>default</emphasis>. In the standard BASE distribution
352              the <emphasis>User</emphasis> role is marked as a default role.
353              </para>
354            </note>
355          </para>
356         
357          <variablelist>
358            <varlistentry>
359              <term><guilabel>Member in</guilabel></term>
360              <listitem>
361                <para>
362                Lists the groups and roles the user already is a member of.
363                </para>
364              </listitem>
365            </varlistentry>
366           
367            <varlistentry>
368              <term><guilabel>Add groups&hellip;</guilabel></term>
369              <listitem>
370                <para>
371                Opens a popup window that allows you to select
372                groups. In the popup window, mark
373                one or more groups and click on the &gbOk;
374                button. The popup window will not list groups that
375                the user already is a member of.
376                </para>
377              </listitem>
378            </varlistentry>
379           
380            <varlistentry>
381              <term><guilabel>Add roles&hellip;</guilabel></term>
382              <listitem>
383                <para>
384                Opens a popup window that allows you to select
385                roles. In the popup window, mark
386                one or more roles and click on the &gbOk;
387                button. The popup window will not list roles that
388                the user already is a member of.
389                </para>
390              </listitem>
391            </varlistentry>
392           
393            <varlistentry>
394              <term><guilabel>Remove</guilabel></term>
395              <listitem>
396                <para>
397                Use this button to remove the user from the selected
398                groups and/or roles. The selected items will then disappear
399                from the list of memberships.
400                </para>
401              </listitem>
402            </varlistentry>
403          </variablelist>
404         
405          <para>
406            Go to the other tabs if there are any changes to do otherwise press
407            &gbSave;
408            to save the values or
409            &gbCancel;
410            to abort.
411          </para>
412          <seeother>
413            <other external_id="user.edit">Edit user</other>
414            <other external_id="user.edit.contact">Edit contact information</other>
415            <other external_id="user.edit.default_membership">Default group and role membership</other>
416          </seeother>
417        </helptext>
418      </sect3>
419    </sect2>
420   
421    <sect2 id="user_administration.users.default_membership">
422      <title>Default group and role membership</title>
423     
424      <helptext external_id="user.edit.default_membership" 
425        title="Default group and role membership">
426        <para>
427          It is possible to automatically let BASE add new users
428          as a member of a pre-defined list of groups and/or roles. This is done
429          by marking those groups and roles as <emphasis>default</emphasis>
430          groups and roles. There are two ways to do this.
431        </para>
432       
433        <orderedlist>
434        <listitem>
435          <para>
436          Change the flag in the edit-dialog for each of the groups/roles
437          that you want to assign as default.
438          </para> 
439        </listitem>
440       
441        <listitem>
442          <para>
443          Use the <guibutton>Default membership</guibutton> button on the
444          <menuchoice>
445            <guimenu>Administrate</guimenu>
446            <guimenuitem>Users</guimenuitem>
447          </menuchoice>
448          page and select groups and roles in a popup dialog.
449          The dialog lists all groups and roles that are currently
450          assigned as default. Use the <guibutton>Add groups</guibutton>
451          and <guibutton>Add roles</guibutton> buttons to select more
452          groups and roles. Use the <guibutton>Remove</guibutton> button
453          to remove the selected groups/roles.
454          </para>
455        </listitem>
456        </orderedlist>
457       
458        <note>
459          <para>
460          Changing which groups and roles that are the default does not affect
461          existing user accounts. They are only used to assign membership to
462          new users.
463          </para>
464        </note>
465        <seeother>
466          <other external_id="user.edit.membership">Edit user group and role membership</other>
467        </seeother>
468      </helptext>
469    </sect2>
470  </sect1>
471
472  <sect1 id="user_administration.groups">
473    <title>Groups administration</title>
474    <para>
475      Groups in BASE are meant to represent the organizational structure of
476      a company or instituion. For example, there can be one group for each
477      department and subgroups for the teams in the departments.
478      The group-membership is normally set when the user is added to BASE and
479      should not have to be changed later, except when the company is re-organizing.
480    </para>
481    <para>
482      There is one pre-installed group in BASE, a system group, called Everyone. It is, like
483      the name says, a group in which everyone (all users) are members. The users that are
484      allowed to share to everyone can easily share items to all users by sharing the item to
485      this group.
486    </para>
487
488    <sect2 id="user_administration.groups.edit">
489      <title>Edit group</title>
490      <para>
491        The pop-up window where a group can be edited has two tabs,
492        <guilabel>Group</guilabel>
493        and
494        <guilabel>Members</guilabel>.
495      </para>
496      <sect3 id="user_administration.groups.edit.properties">
497        <title>Properties</title>
498        <helptext external_id="group.edit" title="Edit group">
499          <variablelist>
500            <varlistentry>
501              <term>
502                <guilabel>Name</guilabel>
503              </term>
504              <listitem>
505                <para>The name of the group.</para>
506              </listitem>
507            </varlistentry>
508            <varlistentry>
509              <term>
510                <guilabel>Default</guilabel>
511              </term>
512              <listitem>
513                <para>
514                  Mark this checkbox to let BASE automatically add new users
515                  as members to this group.
516                </para>
517              </listitem>
518            </varlistentry>
519            <varlistentry>
520              <term>
521                <optional>
522                  <guilabel>Description</guilabel>
523                </optional>
524              </term>
525              <listitem>
526                <para>
527                  Description about the group. The magnifying glass, down to the
528                  right, can be used to open and edit the text in a larger text
529                  area.
530                </para>
531              </listitem>
532            </varlistentry>
533            <varlistentry>
534              <term>
535                <optional>
536                  <guilabel>Quota</guilabel>
537                </optional>
538              </term>
539              <listitem>
540                <para>
541                  With this property it's possible to limit the quota of total
542                  disk space for the group members. Select
543                  <guilabel>-none-</guilabel>
544                  from the drop-down list if the group should not have any quota.
545                  There are some presets of quotas that comes with the BASE2
546                  installation, besides a couple with different size of total disk
547                  space there are one called
548                  <guilabel>No quota</guilabel>
549                  and one with
550                  <guilabel>Unlimited quota</guilabel>.
551                  Their names speak for them self.
552                </para>
553               
554                <note>
555                  <para>
556                  A user can only take quota from one group, which has
557                  to be specified as the <guilabel>Quota group</guilabel>
558                  of the user.
559                  </para>
560                </note>
561               
562              </listitem>
563            </varlistentry>
564          </variablelist>
565          <para>
566            Go to the other tab,
567            <guilabel>Members</guilabel>,
568            if there are any changes to do otherwise use
569            &gbSave;
570            to save the settings or
571            &gbCancel;
572            to abort.
573          </para>
574          <seeother>
575            <other external_id="group.edit.membership">Edit group members</other>
576            <other external_id="user.edit">Edit user</other>
577          </seeother>
578        </helptext>
579      </sect3>
580
581      <sect3 id="user_administration.groups.edit.members">
582        <title>Group members</title>
583        <helptext external_id="group.edit.membership" title="Edit group members">
584          <para>
585            A group can have both single users and other groups as members. Group
586            members have access to those items that are shared to the group. Each user
587            in the group has the possibility to share their own items to one or more of
588            the other members or to the whole group.
589          </para>
590         
591          <variablelist>
592            <varlistentry>
593              <term><guilabel>Members</guilabel></term>
594              <listitem>
595                <para>
596                  Lists the user and groups that are already
597                  members of this group.
598                </para>
599              </listitem>
600            </varlistentry>
601           
602            <varlistentry>
603              <term><guilabel>Add users&hellip;</guilabel></term>
604              <listitem>
605                <para>
606                Opens a popup window that allows you to add
607                users to the group. In the popup window, mark
608                one or more users and click on the &gbOk;
609                button. The popup window will not list users that
610                are already members of the group.
611                </para>
612              </listitem>
613            </varlistentry>
614           
615            <varlistentry>
616              <term><guilabel>Add groups&hellip;</guilabel></term>
617              <listitem>
618                <para>
619                Opens a popup window that allows you to add
620                other groups to the group. In the popup window, mark
621                one or more groups and click on the &gbOk;
622                button. The popup window will not list groups that
623                are already members of the group.
624                </para>
625              </listitem>
626            </varlistentry>
627           
628            <varlistentry>
629              <term><guilabel>Remove</guilabel></term>
630              <listitem>
631                <para>
632                Use this button to remove the selected
633                users and/or groups from this group. The selected items will
634                disappear from the list of memberships.
635                </para>
636              </listitem>
637            </varlistentry>
638           
639          </variablelist>
640         
641          <para>
642            Go to the other tab if there are any changes to do, otherwise use
643            &gbSave;
644            to save the values or
645            &gbCancel;
646            to abort.
647          </para>
648          <seeother>
649            <other external_id="group.edit">Edit group properties</other>
650          </seeother>
651        </helptext>
652      </sect3>
653    </sect2>
654  </sect1>
655
656  <sect1 id="user_administration.roles">
657    <title>Roles administration</title>
658    <para>
659      Roles are meant to represent different kinds of working positions that users can have,
660      like server administrator or regular user just to mention two.
661      Users are normally assigned a role, perhaps more than one, when they are created and
662      registered in BASE.
663    </para>
664
665
666    <sect2 id="user_administration.roles.defaultroles">
667      <title>Pre-defined system roles</title>
668      <para>
669        BASE comes with some pre-defined roles. These are configured to cover the
670        normal user roles that can appear. A more detailed description of the different
671        roles and when to use them follows here.
672      </para>
673      <variablelist>
674        <varlistentry>
675          <term>Administrator</term>
676          <listitem>
677            <para>
678              This role gives the user full permission to do everything in BASE and
679              also possibility to share items with the system-group 'Everyone'. Users
680              that are supposed to administrate the server, user accounts, groups etc.
681              should have this role.
682            </para>
683          </listitem>
684        </varlistentry>
685        <varlistentry>
686          <term>Supervisor</term>
687          <listitem>
688            <para>
689              Users that are members of this role has permission to read everything in
690              BASE. This role does not let the members to actually do anything in BASE
691              except read and supervise.
692            </para>
693          </listitem>
694        </varlistentry>
695        <varlistentry>
696          <term>Power user</term>
697          <listitem>
698            <para>
699              This role allows it's members to do some things that an ordinary user
700              not is allowed to. Most things are related to global resources
701              like reporters, the array lims and plug-ins.
702              This role can be proper for those users that are in
703              some kind of leading position over workgroups or projects.
704            </para>
705          </listitem>
706        </varlistentry>
707        <varlistentry>
708          <term>User</term>
709          <listitem>
710            <para>
711              A role that is suitable for all ordinary users. This allows the members
712              to do common things in BASE such as creating biomaterials and
713              experiments, uploading raw data and analyse it.
714            </para>
715          </listitem>
716        </varlistentry>
717        <varlistentry>
718          <term>Guest</term>
719          <listitem>
720            <para>
721              This is a role with limited access to create new things. It is useful
722              for those who wants to have peek at the program. It can also be
723              used for someone that is helping out with the analysis of an experiment.
724            </para>
725          </listitem>
726        </varlistentry>
727        <varlistentry>
728          <term>Job agent</term>
729          <listitem>
730            <para>
731              This role is given to the job agents and allows them to read and execute
732              jobs. Job agents always runs the jobs as the user who created the job
733              and therefore it have to be able to act as another user.
734            </para>
735          </listitem>
736        </varlistentry>
737      </variablelist>
738    </sect2>
739
740    <sect2 id="user_administration.roles.edit">
741      <title>Edit role</title>
742      <para>
743        Creating a new role or editing the system-roles are something that do not needs to be
744        done very often. The existing roles will normally be enough but there can be some
745        cases when they need to be complemented, either with a new role or with different
746        permissions.
747      </para>
748      <sect3 id="user_administration.roles.edit.properties">
749        <title>Properties</title>
750        <helptext external_id="role.edit" title="Edit role">
751
752          <variablelist>
753            <varlistentry>
754              <term>
755                <guilabel>Name</guilabel>
756              </term>
757              <listitem>
758                <para>The name of the role.</para>
759              </listitem>
760            </varlistentry>
761            <varlistentry>
762              <term>
763                <guilabel>Share to Everyone</guilabel>
764              </term>
765              <listitem>
766                <para>
767                Allows the user to share items to the
768                system-group 'Everyone'.
769                </para>
770              </listitem>
771            </varlistentry>
772           
773            <varlistentry>
774              <term><guilabel>Act as another user</guilabel></term>
775              <listitem>
776                <para>
777                  Allows the user to login as another user without
778                  knowing the password. This is used by job agents
779                  to make it possible for them to execute a plug-in
780                  as the user that created the job. This permission
781                  will also make it possible to switch user in the web
782                  interface. It can be useful for an administrator who
783                  needs to check out a problem, but use this permission
784                  with care.
785                </para>
786              </listitem>
787            </varlistentry>
788            <varlistentry>
789              <term>
790                <guilabel>Default</guilabel>
791              </term>
792              <listitem>
793                <para>
794                  Mark this checkbox to let BASE automatically add new users
795                  as members to the role.
796                </para>
797              </listitem>
798            </varlistentry>
799            <varlistentry>
800              <term>
801                <guilabel>Description</guilabel>
802              </term>
803              <listitem>
804                <para>Description and information about the role.</para>
805              </listitem>
806            </varlistentry>
807          </variablelist>
808          <para>
809            Set the properties and proceed then to either one of the other tabs or by
810            clicking on one of the buttons:
811            &gbSave;
812            to save the changes or
813            &gbCancel;
814            to abort.
815          </para>
816          <seeother>
817            <other external_id="role.edit.permissions">Role permissions</other>
818            <other external_id="role.edit.members">Role members</other>
819          </seeother>
820        </helptext>
821      </sect3>
822
823      <sect3 id="user_administration.roles.edit.permissions">
824        <title>Permissions</title>
825        <helptext external_id="role.edit.permissions" title="Edit role permissions">
826          <para>
827            A role's permissions are defined for each item type within BASE 2. Set the
828            role's permission on an item type by first selecting the item(s) in the list
829            and then tick those permissions that should be applied. Not all permissions
830            can be applied to every item type, that's why permission check-boxes becomes
831            disabled when selecting some of the item types
832          </para>
833          <para>
834            After each item type in the list is a string inside square brackets that
835            shows what kind of permissions the current role has on that particular item
836            type. The permissions that do not have been set are represented with '-'
837            inside the square brackets and those which have been set are represented
838            with characters that are listed below.
839          </para>
840          <itemizedlist>
841            <listitem>
842              <simpara>
843                <guilabel>DENIED</guilabel>
844                = Deny access to the selected item type. This exclude all the other
845                permissions by unchecking the other check boxes.
846              </simpara>
847            </listitem>
848            <listitem>
849              <simpara>
850                <guilabel>C</guilabel>
851                = Create
852              </simpara>
853            </listitem>
854            <listitem>
855              <simpara>
856                <guilabel>R</guilabel>
857                = Read
858              </simpara>
859            </listitem>
860            <listitem>
861              <simpara>
862                <guilabel>U</guilabel>
863                = Use
864              </simpara>
865            </listitem>
866            <listitem>
867              <simpara>
868                <guilabel>W</guilabel>
869                = Write
870              </simpara>
871            </listitem>
872            <listitem>
873              <simpara>
874                <guilabel>D</guilabel>
875                = Delete
876              </simpara>
877            </listitem>
878            <listitem>
879              <simpara>
880                <guilabel>O</guilabel>
881                = Take ownership
882              </simpara>
883            </listitem>
884            <listitem>
885              <simpara>
886                <guilabel>P</guilabel>
887                = Set permission
888              </simpara>
889            </listitem>
890          </itemizedlist>
891          <para>
892            Set the role's permission on each one of the item types and proceed then to
893            one of the other tabs or click on
894            &gbSave;
895            to save the changes or
896            &gbCancel;
897            to abort.
898          </para>
899          <seeother>
900            <other external_id="role.edit">Edit properties</other>
901            <other external_id="role.edit.members">Role members</other>
902          </seeother>
903        </helptext>
904      </sect3>
905
906      <sect3 id="user_administration.roles.edit.members">
907        <title>Members</title>
908        <helptext external_id="role.edit.members" title="Role members">
909       
910        <variablelist>
911          <varlistentry>
912            <term><guilabel>Members</guilabel></term>
913            <listitem>
914              <para>
915              Users that are members of a role are listed in the list-box located on this
916              tab.
917              </para>
918            </listitem>
919          </varlistentry>
920          <varlistentry>
921            <term><guibutton>Add users</guibutton></term>
922            <listitem>
923              <para>
924                Select the users that should be added from the list in the
925                pop-up window. Click on the
926                &gbOk;
927                button to close the pop-up window and add the selected users.
928              </para>
929            </listitem>
930          </varlistentry>
931          <varlistentry>
932              <term>Remove</term>
933              <listitem>
934                <para>
935                  Removes the selected users from the role.
936                </para>
937              </listitem>
938            </varlistentry>
939          </variablelist>
940          <para>
941            Press
942            &gbSave;
943            to save the role or go to one of the other tabs if there are more that needs
944            to be set. Use
945            &gbClose;
946            to abort and close the window without saving the changes.
947          </para>
948          <seeother>
949            <other external_id="role.edit">Edit properties</other>
950            <other external_id="role.edit.permissions">Role permissions</other>
951          </seeother>
952        </helptext>
953      </sect3>
954    </sect2>
955  </sect1>
956
957  <sect1 id="user_administration.quota">
958    <title>Disk space/quota</title>
959    <para>
960      The administrator can control the maximum size of disk space for users and groups.
961      A user must be assigned a quota of their own and may optionally have a group
962      quota as well. If so, the most restrictive quota is checked whenever the user
963      tries to do something that counts as disk-consuming, for example uploading a file.
964    </para>
965   
966    <note>
967      <para>
968      The quota is checked before an operation, which is allowed to continue if there
969      is space left. For example, even if you have only one byte left of disk space
970      you are allowed to upload a 10MB file.
971      </para>
972    </note>
973     
974    <para>
975      Read
976      <xref linkend="user_administration.users.edit" />
977      and <xref linkend="user_administration.groups.edit" />
978      for information about how to set a quota for a user and
979      group.
980    </para>
981    <para>
982      The list of quotas in BASE can be found by using the menu
983      <menuchoice>
984        <guimenu>Administrate</guimenu>
985        <guimenuitem>Quota</guimenuitem>
986      </menuchoice>.
987    </para>
988
989    <sect2 id="user_administration.quota.edit">
990      <title>Edit quota</title>
991      <para>
992        The edit window has two tabs, one with information about the quota and one where the
993        limits are defined.
994      </para>
995      <sect3 id="user_administration.quota.edit.properties">
996        <title>Properties</title>
997        <helptext external_id="quota.edit" title="Edit properties">
998          <variablelist>
999            <varlistentry>
1000              <term>
1001                <guilabel>Name</guilabel>
1002              </term>
1003              <listitem>
1004                <para>Name of the quota.</para>
1005              </listitem>
1006            </varlistentry>
1007            <varlistentry>
1008              <term>
1009                <optional>
1010                  <guilabel>Description</guilabel>
1011                </optional>
1012              </term>
1013              <listitem>
1014                <para>
1015                  Description of the quota. It could be a good idea to
1016                  describe the quota's details here. Use the magnifying glass to
1017                  edit the text in a larger text area.
1018                </para>
1019              </listitem>
1020            </varlistentry>
1021          </variablelist>
1022          <para>
1023            Go to the other tab if there are values that have not been set. Otherwise use
1024            &gbSave;
1025            to save the settings or
1026            &gbCancel;
1027            to abort.
1028          </para>
1029        </helptext>
1030      </sect3>
1031
1032      <sect3 id="user_administration.quota.edit.values">
1033        <title>Values</title>
1034        <helptext external_id="quota.edit.values" title="Edit quota values">
1035          <para>
1036            The quota values are defined here, both for the primary location and the
1037            secondary location. Use the check box to the right of the input fields to
1038            set unlimited quota. You can use the abbreviations
1039            <abbrev>kb</abbrev>, <abbrev>Mb</abbrev> and <abbrev>Gb</abbrev>
1040            to specify the quota values.
1041          </para>
1042          <variablelist>
1043            <varlistentry>
1044              <term>
1045                <guilabel>Total</guilabel>
1046              </term>
1047              <listitem>
1048                <para>
1049                  Limit of total quota. The sum of the other three quotas does not
1050                  have to be the same as this, it is always the most restricted
1051                  value that is used.
1052                </para>
1053              </listitem>
1054            </varlistentry>
1055            <varlistentry>
1056              <term>
1057                <optional>
1058                  <guilabel>Files</guilabel>
1059                </optional>
1060              </term>
1061              <listitem>
1062                <para>Limit of disk space to save files in.</para>
1063              </listitem>
1064            </varlistentry>
1065            <varlistentry>
1066              <term>
1067                <optional>
1068                  <guilabel>Raw data</guilabel>
1069                </optional>
1070              </term>
1071              <listitem>
1072                <para>Limit of disk space to save raw data in.</para>
1073              </listitem>
1074            </varlistentry>
1075            <varlistentry>
1076              <term>
1077                <optional>
1078                  <guilabel>Experiments</guilabel>
1079                </optional>
1080              </term>
1081              <listitem>
1082                <para>
1083                  Limit of disk space that can be used by experiments.
1084                </para>
1085              </listitem>
1086            </varlistentry>
1087          </variablelist>
1088          <para>
1089            When everything have been set the quota is saved by using
1090            &gbSave;. To discard changes use
1091            &gbCancel;.
1092          </para>
1093        </helptext>
1094      </sect3>
1095    </sect2>
1096   
1097    <sect2 id="user_administration.quota.diskusage">
1098      <title>Disk usage</title>
1099     
1100      <para>
1101        Go to
1102        <menuchoice>
1103          <guimenu>Administrate</guimenu>
1104          <guimenuitem>Disk usage</guimenuitem>
1105        </menuchoice>
1106        if you want to get statistics about how the disk
1107        is used. There are three tabs:
1108      </para>
1109     
1110      <variablelist>
1111        <varlistentry>
1112          <term><guilabel>Overview</guilabel></term>
1113          <listitem>
1114            <para>
1115              Gives an overview of the total disk usage.
1116              It is divided per location and quota type.
1117            </para>
1118          </listitem>
1119        </varlistentry>
1120
1121        <varlistentry>
1122          <term><guilabel>Per user</guilabel></term>
1123          <listitem>
1124            <para>
1125              Gives an overview of the disk usage
1126              per user. For each user you can get a summary
1127              displaying the total disk usage and
1128              divided per location and quota type.
1129              Use the <guilabel>View details</guilabel>
1130              link to list all items that uses up disk space.
1131              The list displays the name and type of each item
1132              and the amount of disk space it uses.
1133            </para>
1134          </listitem>
1135        </varlistentry>
1136       
1137        <varlistentry>
1138          <term><guilabel>Per group</guilabel></term>
1139          <listitem>
1140            <para>
1141              Gives an overview of the disk usage
1142              per group, with the same functionality
1143              as the per user overview.
1144            </para>
1145          </listitem>
1146        </varlistentry>
1147      </variablelist>
1148     
1149    </sect2>
1150   
1151  </sect1>
1152</chapter>
Note: See TracBrowser for help on using the repository browser.