Changeset 3357


Ignore:
Timestamp:
May 22, 2007, 8:28:09 AM (14 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #549.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/admindoc/user_administration.xml

    r3326 r3357  
    3131  <title>Account administration</title>
    3232
    33   <sect1 id="user_administration.permissions">
    34     <title>Permission system</title>
     33  <important>
     34    <title>Read <link linkend="project_permission"><xref linkend="project_permission" /></link></title>
    3535    <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.
     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.
    3940    </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>
     41  </important>
    5042
    5143  <sect1 id="user_administration.users">
    … …  
    6355      <title>Edit user</title>
    6456      <para>
    65         The pop-up window where information and settings for an user can be edit has three
     57        The pop-up window where information and settings for a user can be edited has three
    6658        tabs, one for the account related, one with information about the user and one that
    6759        shows the user's memberships.
    6860      </para>
    6961      <sect3 id="user_administration.users.edit.properties">       
    70           <title>Properties</title>
    71           <helptext external_id="user.edit" title="Edit user account">
    72           <para>These are the properties for an user account.</para>
     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>
    7365          <variablelist>
    7466            <varlistentry>
    … …  
    7971                <para>
    8072                  The full name of the user that is associated with the account.
    81                   (Required)
    8273                </para>
    8374              </listitem>
    … …  
    8980              <listitem>
    9081                <para>
    91                   A login name to use when logging in to the account. (Required)
     82                  A login name to use when logging in to the account. The login
     83                  must be unique among all users.
    9284                </para>
    9385              </listitem>
    … …  
    10193              <listitem>
    10294                <para>
    103                   An id that is used to identify the user outside BASE. (Optional)
     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.
    10497                </para>
    10598              </listitem>
    … …  
    125118                <para>
    126119                  Retype the password that is written in
    127                   <guilabel>New password</guilabel>
    128                   .
     120                  <guilabel>New password</guilabel>.
    129121                </para>
    130122              </listitem>
    … …  
    137129              </term>
    138130              <listitem>
    139                 <para>Set disc quota for the account.(Required)</para>
     131                <para>Set disk quota for the account.</para>
    140132              </listitem>
    141133            </varlistentry>
    … …  
    149141                <para>
    150142                  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)
     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.
    154146                </para>
    155147              </listitem>
    … …  
    163155              <listitem>
    164156                <para>
    165                   Set the account's home directory. A new directory, either empty
     157                  Set the account's home directory (optional). A new directory, either empty
    166158                  or from a template, can be created if editing a new user. Select
    167159                  <guilabel>- none -</guilabel>
    168160                  if there shouldn't be any home directory asocciated with the
    169                   account.(Optional)
     161                  account.
    170162                </para>
    171163              </listitem>
    … …  
    180172                <para>
    181173                  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)
     174                  certain day (optional). The account will be disabled after this date.
     175                  Leave this empty if the account never should expire.
    184176                  <tip>
    185177                    <para>
    186                       Use
     178                      Use the
    187179                      <guibutton>Calendar&hellip;</guibutton>
    188                       to pick a date from a calendar in a pop-up window.
     180                      button to pick a date from a calendar in a pop-up window.
    189181                    </para>
    190182                  </tip>
    … …  
    199191                <para>
    200192                  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.
     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.
    204198                </para>
    205199              </listitem>
    … …  
    211205              <listitem>
    212206                <para>
    213                   Disable the account for further use by check this. The account
    214                   can't be used until this is unchecked.
     207                  Disable the account.
    215208                </para>
    216209              </listitem>
    … …  
    225218          </para>
    226219          <seeother>
    227             <other external_id="user.edit.contact">Edit user's contact information</other>
    228             <other external_id="user.edit.membership">Edit user's membership</other>
     220            <other external_id="user.edit.contact">Edit contact information</other>
     221            <other external_id="user.edit.membership">Group and role membership</other>
    229222          </seeother>
    230223        </helptext>
    … …  
    312305              </term>
    313306              <listitem>
    314                 <para>An URL that is associated with the user.</para>
     307                <para>A URL that is associated with the user.</para>
    315308              </listitem>
    316309            </varlistentry>
    … …  
    339332          <seeother>
    340333            <other external_id="user.edit">Edit account</other>
    341             <other external_id="user.edit.membership">Edit user's membership</other>
     334            <other external_id="user.edit.membership">Group and role membership</other>
    342335          </seeother>
    343336        </helptext>
    … …  
    346339
    347340      <sect3 id="user_administration.users.edit.membership">
    348         <title>User's membership</title>
    349         <helptext external_id="user.edit.membership" title="Edit user's membership">
    350           <para>
    351             An user's membership in groups and roles can be set on this tab. The
    352             membership can also be changed by adding/removing the user to/from a
    353             group's/role's list of members that is described in
    354             <xref linkend="user_administration.groups.edit" />
    355             and
    356             <xref linkend="user_administration.roles.edit" />
    357           </para>
    358           <para>
    359             Use
    360             <guibutton>Add groups&hellip;</guibutton>
    361             or
    362             <guibutton>Add roles&hellip;</guibutton>
    363             to add a membership in a group or a role. Mark the check-boxes for those
    364             groups or roles that the user should become a member in. Using the
    365             <guibutton>Ok</guibutton>
    366             will add the selected items to the list of memberships.
    367           </para>
    368           <para>
    369             Memberships are removed by selecting items from the list of memberships and
    370             the pressing
    371             <guibutton>Remove</guibutton>
    372             . The selected items will then disappear from the list of memberships.
    373           </para>
     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 <guibutton>Ok</guibutton>
     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 <guibutton>Ok</guibutton>
     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         
    374397          <para>
    375398            Go to the other tabs if there are any changes to do otherwise press
    … …  
    381404          <seeother>
    382405            <other external_id="user.edit">Edit account</other>
    383             <other external_id="user.edit.contact">
    384               Edit user's contact information
    385             </other>
     406            <other external_id="user.edit.contact">Edit contact information</other>
    386407          </seeother>
    387408        </helptext>
    … …  
    393414    <title>Groups administration</title>
    394415    <para>
    395       Groups in BASE are meant to represent physical groups that are working with the program.
    396       It can be departments in an organization or some kind of lab teams, just to mention some
    397       examples. An user's group-membership is normally set when the user is added to BASE and
    398       has no needs to be changed later , except when the company is re-organizing.
     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.
    399421    </para>
    400422    <para>
    401423      There is one pre-installed group in BASE, a system group, called Everyone. It is, like
    402       the name says, a group in which everyone(all users) are members. The users that are
     424      the name says, a group in which everyone (all users) are members. The users that are
    403425      allowed to share to everyone can easily share items to all users by sharing the item to
    404426      this group.
    … …  
    408430      <title>Edit group</title>
    409431      <para>
    410         The pop-up window where a group can be edit has two tabs,
     432        The pop-up window where a group can be edited has two tabs,
    411433        <guilabel>Group</guilabel>
    412434        and
    413         <guilabel>Members</guilabel>
     435        <guilabel>Members</guilabel>.
    414436      </para>
    415       <helptext external_id="group.edit" title="Edit group">
    416         <sect3 id="user_administration.groups.edit.properties">
    417           <title>Properties</title>
     437      <sect3 id="user_administration.groups.edit.properties">
     438        <title>Properties</title>
     439        <helptext external_id="group.edit" title="Edit group">
    418440          <variablelist>
    419441            <varlistentry>
    … …  
    422444              </term>
    423445              <listitem>
    424                 <para>Group's name.(Required)</para>
     446                <para>The name of the group.</para>
    425447              </listitem>
    426448            </varlistentry>
    … …  
    448470                <para>
    449471                  With this property it's possible to limit the quota of total
    450                   disc space for the group members. Select
     472                  disk space for the group members. Select
    451473                  <guilabel>-none-</guilabel>
    452474                  from the drop-down list if the group shouldn't have any quota.
    453475                  There are some presets of quotas that comes with the BASE2
    454                   installation, besides a couple with different size of total disc
     476                  installation, besides a couple with different size of total disk
    455477                  space there are one called
    456478                  <guilabel>No quota</guilabel>
    457479                  and one with
    458                   <guilabel>Unlimited quota</guilabel>
    459                   . Their names speak for them self.
    460                 </para>
     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               
    461492              </listitem>
    462493            </varlistentry>
    463494          </variablelist>
    464         </sect3>
    465         <para>
    466           Go to the other tab,
    467           <guilabel>Members</guilabel>
    468           , if there are any changes to do otherwise use
    469           <guibutton>Save</guibutton>
    470           to save the settings or
    471           <guibutton>Cancel</guibutton>
    472           to abort.
    473         </para>
    474         <seeother>
    475           <other external_id="group.edit.membership">Edit group members</other>
    476         </seeother>
    477       </helptext>
    478 
    479       <helptext external_id="group.edit.membership" title="Edit group members">
    480         <sect3 id="user_administration.groups.edit.members">
    481           <title>Group members</title>
    482           <para>
    483             A group can have both single users and whole groups as members. Group
     495          <para>
     496            Go to the other tab,
     497            <guilabel>Members</guilabel>,
     498            if there are any changes to do otherwise use
     499            <guibutton>Save</guibutton>
     500            to save the settings or
     501            <guibutton>Cancel</guibutton>
     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
    484516            members have access to those items that are shared to the group. Each user
    485517            in the group has the possibility to share their own items to one or more of
    486518            the other members or to the whole group.
    487519          </para>
    488           <para>
    489             The list-box shows the group's members, both users and other groups.
    490 
    491             Removing members from a group are done by first select one or several
    492             members in the list and then click on
    493             <guibutton>Remove</guibutton>
    494             . The selected items will then disappear from the list.
    495           </para>
    496         </sect3>
    497         <para>
    498           Go to the other tab if there are any changes to do, otherwise use
    499           <guibutton>Save</guibutton>
    500           to save the values or
    501           <guibutton>Cancel</guibutton>
    502           to abort.
    503         </para>
    504         <seeother>
    505           <other external_id="group.edit">Edit group properties</other>
    506         </seeother>
    507       </helptext>
     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 <guibutton>Ok</guibutton>
     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 <guibutton>Ok</guibutton>
     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            <guibutton>Save</guibutton>
     574            to save the values or
     575            <guibutton>Cancel</guibutton>
     576            to abort.
     577          </para>
     578          <seeother>
     579            <other external_id="group.edit">Edit group properties</other>
     580          </seeother>
     581        </helptext>
     582      </sect3>
    508583    </sect2>
    509584  </sect1>
    … …  
    512587    <title>Roles administration</title>
    513588    <para>
    514       Roles are different kinds of working positions that users can have, like server
    515       administrator or regular user just to mention two. The permissions for a role are set
    516       depending on what it is going to do in BASE.
    517     </para>
    518     <para>
    519       Users are normally assigned a role, perhaps more then one, when they are created and
     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
    520592      registered in BASE.
    521593    </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>
    522669
    523670    <sect2 id="user_administration.roles.edit">
    … …  
    529676        permissions.
    530677      </para>
    531       <helptext external_id="role.edit" title="Edit role">
    532         <sect3 id="user_administration.roles.edit.properties">
    533           <title>Properties</title>
    534           <para>These are the properties that can be defined for a role.</para>
     678      <sect3 id="user_administration.roles.edit.properties">
     679        <title>Properties</title>
     680        <helptext external_id="role.edit" title="Edit role">
     681
    535682          <variablelist>
    536683            <varlistentry>
    … …  
    539686              </term>
    540687              <listitem>
    541                 <para>The role's name. (Required)</para>
    542               </listitem>
    543             </varlistentry>
    544             <varlistentry>
    545               <term>
    546                 <guilabel>System-level permissions</guilabel>
    547               </term>
    548               <listitem>
    549                 <itemizedlist>
    550                   <listitem>
    551                     <simpara>
    552                       With
    553                       <guilabel>Share to Everyone</guilabel>
    554                       set the role allows the user to share items to the
    555                       system-group 'Everyone'.
    556                     </simpara>
    557                   </listitem>
    558                   <listitem>
    559                     <simpara>
    560                       <guilabel>Act as another user</guilabel>
    561                       - property makes it possible for the one with this role
    562                       to login from the menu bar as another user. This is used
    563                       by job agents when they should act as the user who
    564                       created the job.
    565                     </simpara>
    566                   </listitem>
    567                 </itemizedlist>
     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>
    568716              </listitem>
    569717            </varlistentry>
    … …  
    573721              </term>
    574722              <listitem>
    575                 <para>Description and information about the role.(Optional)</para>
     723                <para>Description and information about the role.</para>
    576724              </listitem>
    577725            </varlistentry>
    … …  
    585733            to abort.
    586734          </para>
    587         </sect3>
    588         <seeother>
    589           <other external_id="role.edit.permissions">Role permissions</other>
    590           <other external_id="role.edit.members">Role members</other>
    591         </seeother>
    592       </helptext>
    593 
    594       <helptext external_id="role.edit.permissions" title="Edit role permissions">
    595         <sect3 id="user_administration.roles.edit.permissions">
    596           <title>Permissions</title>
     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">
    597745          <para>
    598746            A role's permissions are defined for each item type within BASE 2. Set the
    … …  
    662810          <para>
    663811            Set the role's permission on each one of the item types and proceed then to
    664             one of the other tabs or click on one of the buttons:
     812            one of the other tabs or click on
    665813            <guibutton>Save</guibutton>
    666814            to save the changes or
    … …  
    668816            to abort.
    669817          </para>
    670         </sect3>
    671         <seeother>
    672           <other external_id="role.edit">Edit properties</other>
    673           <other external_id="role.edit.members">Role members</other>
    674         </seeother>
    675       </helptext>
    676 
    677       <helptext external_id="role.edit.members" title="Role members">
    678         <sect3 id="user_administration.roles.edit.members">
    679           <title>Members</title>
    680           <para>
    681             Users that are members of a role are listed in the list-box located on this
    682             tab. Members can be added or removed with the two buttons, located to the
    683             right of the list box,
    684             <guibutton>Add users&hellip;</guibutton>
    685             and
    686             <guibutton>Remove</guibutton>
    687             .
    688           </para>
    689           <variablelist>
    690             <varlistentry>
    691               <term>Add users to list</term>
    692               <listitem>
    693                 <para>
    694                   Click on
    695                   <guibutton>Add users&hellip;</guibutton>
    696                   and select the users that should be added from the list in the
    697                   pop-up window. Press then on the
    698                   <guibutton>Ok</guibutton>
    699                   button to close the pop-up window and add the selected users.
    700                   Use
    701                   <guibutton>Cancel</guibutton>
    702                   or just close the pop-up to abort and return to main window.
    703                 </para>
    704               </listitem>
    705             </varlistentry>
    706             <varlistentry>
    707               <term>Remove users from list</term>
    708               <listitem>
    709                 <para>
    710                   Members are removed from the list by first selecting them and
    711                   then pressing
    712                   <guibutton>Remove</guibutton>
    713                   . The selected user(s) are removed immediately.
     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                <guibutton>Ok</guibutton>
     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.
    714855                </para>
    715856              </listitem>
    … …  
    724865            to abort and close the window without saving the changes.
    725866          </para>
    726         </sect3>
    727         <seeother>
    728           <other external_id="role.edit">Edit properties</other>
    729           <other external_id="role.edit.permissions">Role permissions</other>
    730         </seeother>
    731       </helptext>
    732     </sect2>
    733 
    734     <sect2 id="user_administration.roles.defaultroles">
    735       <title>Default roles</title>
    736       <para>
    737         There are some default roles that come with BASE2. These are configured to cover the
    738         normal user roles that can appear. A more detailed description of the different
    739         roles and when to use them follows here.
    740       </para>
    741       <variablelist>
    742         <varlistentry>
    743           <term>Administrator</term>
    744           <listitem>
    745             <para>
    746               This role gives the user full permission to do everything in BASE and
    747               also possibility to share items with the system-group 'Everyone'. Users
    748               that are supposed to administrate the server, user accounts, groups etc.
    749               should have this role.
    750             </para>
    751           </listitem>
    752         </varlistentry>
    753         <varlistentry>
    754           <term>Supervisor</term>
    755           <listitem>
    756             <para>
    757               Users that are members of this role has permission to read everything in
    758               BASE. This role doesn't let the members to actually do anything in BASE
    759               except read and supervise.
    760             </para>
    761           </listitem>
    762         </varlistentry>
    763         <varlistentry>
    764           <term>Power user</term>
    765           <listitem>
    766             <para>
    767               This role allows it's members to do some things that an ordinary user
    768               not is allowed to. This role can be proper for those users that are in
    769               some kind of leading position over workgroups or projects.
    770             </para>
    771           </listitem>
    772         </varlistentry>
    773         <varlistentry>
    774           <term>User</term>
    775           <listitem>
    776             <para>
    777               A role that is suitable for all ordinary users. This allows the members
    778               to do common things in BASE as analysis, creating biomaterials and
    779               experiments and so on.
    780             </para>
    781           </listitem>
    782         </varlistentry>
    783         <varlistentry>
    784           <term>Guest</term>
    785           <listitem>
    786             <para>
    787               This is a role with limited access to create new things. It is useful
    788               for those who wants to have peek at the program.
    789             </para>
    790           </listitem>
    791         </varlistentry>
    792         <varlistentry>
    793           <term>Job agent</term>
    794           <listitem>
    795             <para>
    796               This role is given to the job agents and allows them to read and execute
    797               jobs. Job agents always runs the jobs as the user who created the job
    798               and therefore it have to be able to act as another user. No more
    799               permissions then these are needed for job agents.
    800             </para>
    801           </listitem>
    802         </varlistentry>
    803       </variablelist>
     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>
    804873    </sect2>
    805874  </sect1>
    806875
    807876  <sect1 id="user_administration.quota">
    808     <title>Disc space/quota</title>
     877    <title>Disk space/quota</title>
    809878    <para>
    810       The administrator can control the maximum size of disc space that each user should be
    811       able to use. Also groups can have limited disc quota and this will effect when an user,
    812       that is member of a quota group, is saving something to the database that is disc
    813       consuming. The most restricted one of the group's quota and user's quota will be used
    814       and the user will be denied to store the item on the server if one of the disc quotas is
    815       filled.
     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.
    816883    </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     
    817893    <para>
    818       How to set an user's quota or to create a quota can be read at
    819       <xref linkend="user_administration.groups.edit" />
    820       and
     894      Read
    821895      <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.
    822899    </para>
    823900    <para>
    … …  
    826903        <guimenu>Administrate</guimenu>
    827904        <guimenuitem>Quota</guimenuitem>
    828       </menuchoice>
    829       .
     905      </menuchoice>.
    830906    </para>
    831907
    … …  
    836912        limits are defined.
    837913      </para>
    838       <helptext external_id="quota.edit" title="Edit properties">
    839         <sect3 id="user_administration.quota.edit.properties">
    840           <title>Properties</title>
     914      <sect3 id="user_administration.quota.edit.properties">
     915        <title>Properties</title>
     916        <helptext external_id="quota.edit" title="Edit properties">
    841917          <variablelist>
    842918            <varlistentry>
    … …  
    845921              </term>
    846922              <listitem>
    847                 <para>Name of the quota (Required).</para>
     923                <para>Name of the quota.</para>
    848924              </listitem>
    849925            </varlistentry>
    … …  
    858934                  Description of the quota. It could be a good idea to
    859935                  describe the quota's details here. Use the magnifying glass to
    860                   edit the text in a larger text area.(Optional)
     936                  edit the text in a larger text area.
    861937                </para>
    862938              </listitem>
    … …  
    870946            to abort.
    871947          </para>
    872         </sect3>
    873       </helptext>
    874 
    875       <helptext external_id="quota.edit.values" title="Edit values">
    876         <sect3 id="user_administration.quota.edit.values">
    877           <title>Values</title>
     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">
    878954          <para>
    879955            The quota values are defined here, both for the primary location and the
    880956            secondary location. Use the check box to the right of the input fields to
    881             set unlimited quota.
     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.
    882960          </para>
    883961          <variablelist>
    … …  
    890968                  Limit of total quota. The sum of the other three quotas doesn't
    891969                  have to be the same as this, it is always the most restricted
    892                   value that is used.(Required)
     970                  value that is used.
    893971                </para>
    894972              </listitem>
    … …  
    901979              </term>
    902980              <listitem>
    903                 <para>Limit of disc space to save files in.(Optional)</para>
     981                <para>Limit of disk space to save files in.</para>
    904982              </listitem>
    905983            </varlistentry>
    … …  
    911989              </term>
    912990              <listitem>
    913                 <para>disc space to save Raw data in.(Optional)</para>
     991                <para>Limit of disk space to save raw data in.</para>
    914992              </listitem>
    915993            </varlistentry>
    … …  
    9221000              <listitem>
    9231001                <para>
    924                   Limit of disc space that can be used by experiments.(Optional)
     1002                  Limit of disk space that can be used by experiments.
    9251003                </para>
    9261004              </listitem>
    … …  
    9291007          <para>
    9301008            When everything have been set the quota is saved by using
    931             <guibutton>Save</guibutton>
    932             . To discard changes use
    933             <guibutton>Cancel</guibutton>
    934             .
    935           </para>
    936         </sect3>
    937       </helptext>
     1009            <guibutton>Save</guibutton>. To discard changes use
     1010            <guibutton>Cancel</guibutton>.
     1011          </para>
     1012        </helptext>
     1013      </sect3>
    9381014    </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   
    9391070  </sect1>
    9401071</chapter>
Note: See TracChangeset for help on using the changeset viewer.