Changeset 3313


Ignore:
Timestamp:
May 9, 2007, 1:22:17 PM (14 years ago)
Author:
Martin Svensson
Message:

Reference #549. First revision of the whole chapter

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/admindoc/user_administration.xml

    r3310 r3313  
    3030  <?dbhtml dir="user_administration"?>
    3131  <title>Account administration</title>
    32  
     32
    3333  <sect1 id="user_administration.permissions">
    3434    <title>Permission system</title>
    3535    <para>
    3636      Users get their general permissions from the role they belong to and more item specific
    37       permissions from shared items in groups and projects that they are members in. An user
    38       has always full permissions on it's own items.
    39     </para>
    40     <para>
    41       As an administrator you only have to think of what kinds of tasks an user is going to work
    42       with and give he/she the appropriate role for that.
     37      permissions from shared items in groups and projects they are members in. An user has
     38      always full permissions on it's own items.
     39    </para>
     40    <para>
     41      As an administrator you only have to think of what kinds of tasks an user is going to
     42      work with and give he/she the appropriate role for that. The rest of the permissions
     43      should the user normally get from the projects he/she is a member in.
    4344    </para>
    4445    <para>
     
    5657        <guimenuitem>Users</guimenuitem>
    5758      </menuchoice>
    58       and from here are users' account and contact information managed.
     59      and from here are the users' account and contact information managed.
    5960    </para>
    6061
    6162    <sect2 id="user_administration.users.edit">
    62       <title>Edit user</title>     
    63 
     63      <title>Edit user</title>
     64      <para>
     65        The pop-up window where information and settings for an user can be edit has three
     66        tabs, one for the account related, one with information about the user and one that
     67        shows the user's memberships.
     68      </para>
    6469      <helptext external_id="user.edit" title="Edit user account">
    6570        <sect3 id="user_administration.users.edit.properties">
    6671          <title>Properties</title>
    67           <para>
    68             These are the properties for an user account.
    69           </para>
     72          <para>These are the properties for an user account.</para>
    7073          <variablelist>
    7174            <varlistentry>
     
    7578              <listitem>
    7679                <para>
    77                   The full name of the user that is associated with this account.
     80                  The full name of the user that is associated with the account.
    7881                  (Required)
    7982                </para>
     
    8689              <listitem>
    8790                <para>
    88                   A login name to use when logging in to this account. (Required)
     91                  A login name to use when logging in to the account. (Required)
    8992                </para>
    9093              </listitem>
     
    97100              </term>
    98101              <listitem>
    99                 <para>Id used identify the user outside BASE. (Optional)</para>
     102                <para>
     103                  An id that is used to identify the user outside BASE. (Optional)
     104                </para>
    100105              </listitem>
    101106            </varlistentry>
     
    106111              <listitem>
    107112                <para>
    108                   This is used together with the login name to log in with this
    109                   account. This is required for a new user or if the password
    110                   should be changed.
     113                  This is used together with the login name to log in to the
     114                  account. This is a required field for a new user or if the
     115                  password should be changed. If the field is left empty the
     116                  password will be unchanged
    111117                </para>
    112118              </listitem>
     
    118124              <listitem>
    119125                <para>
    120                   Retype the password in <guilabel>New password</guilabel>.
     126                  Retype the password that is written in
     127                  <guilabel>New password</guilabel>
     128                  .
    121129                </para>
    122130              </listitem>
     
    129137              </term>
    130138              <listitem>
    131                 <para>Set disk quota for this account.(Required)</para>
     139                <para>Set disc quota for the account.(Required)</para>
    132140              </listitem>
    133141            </varlistentry>
     
    142150                  Set this if the account should belong to a group with specified
    143151                  quota. With this set the user's possibilities to save items to
    144                   disk will also depends on how much the rest of the group has
     152                  disc will also depend on how much the rest of the group has
    145153                  saved.(Optional)
    146154                </para>
     
    156164                <para>
    157165                  Set the account's home directory. A new directory, either empty
    158                   or from a template, can be created if editing a new
    159                   user.(Optional)
     166                  or from a template, can be created if editing a new user. Select
     167                  <guilabel>- none -</guilabel>
     168                  if there shouldn't be any home directory asocciated with the
     169                  account.(Optional)
    160170                </para>
    161171              </listitem>
     
    170180                <para>
    171181                  Define a date in this field if the account should expire on a
    172                   certain day. The account will be disabled after this
    173                   date.(Optional)
     182                  certain day. The account will be disabled after this date. Leave
     183                  this empty if the account should be continuous. (Optional)
    174184                  <tip>
    175185                    <para>
    176186                      Use
    177187                      <guibutton>Calendar&hellip;</guibutton>
    178                       to pick a date from a calendar-pop-up window.
     188                      to pick a date from a calendar in a pop-up window.
    179189                    </para>
    180190                  </tip>
     
    188198              <listitem>
    189199                <para>
    190                   This checkbox should be ticked if the account should be used by
     200                  This checkbox should be checked if the account should be used by
    191201                  more one user. It will block the users of the account to change
    192                   password, contact information and other personal information.
     202                  password, contact information and other settings that will mess
     203                  up the use of the account.
    193204                </para>
    194205              </listitem>
     
    200211              <listitem>
    201212                <para>
    202                   Disable the account to be used.
     213                  Disable the account for further use by check this. The account
     214                  can't be used until this is unchecked.
    203215                </para>
    204216              </listitem>
     
    222234          <title>Contact information</title>
    223235          <para>
    224             Information how get in contact with the user that is connected to the
    225             account. All fields on this tab are optional and do not necessarily need to
    226             have a value.
     236            Information about how to get in contact with the user that is asocciated
     237            with the account. All fields on this tab are optional and do not necessarily
     238            need to have a value but some can be good to set, like email or phone
     239            number.
    227240          </para>
    228241          <variablelist>
     
    235248              <listitem>
    236249                <para>
    237                   User's email address.There is some verification of the value but
    238                   their is no check if the email really exists.
    239                 </para>
    240               </listitem>
    241             </varlistentry>
    242             <varlistentry>
    243               <term>
    244                 <optional>
    245                   <guilabel>Organisation</guilabel>
    246                 </optional>
    247               </term>
    248               <listitem>
    249                 <para>
    250                   The company or organisation that the user works for.
    251                 </para>
     250                  User's email address. There is some verification of the value
     251                  but there is no check if the email really exists.
     252                </para>
     253              </listitem>
     254            </varlistentry>
     255            <varlistentry>
     256              <term>
     257                <optional>
     258                  <guilabel>Organization</guilabel>
     259                </optional>
     260              </term>
     261              <listitem>
     262                <para>The company or organization that the user works for.</para>
    252263              </listitem>
    253264            </varlistentry>
     
    260271              <listitem>
    261272                <para>
    262                   User's address. Use the magnifying glas down to the right, to
    263                   edit this property in a larger window - opened in a pop-up
    264                   window.
     273                  User's mail address. Use the magnifying glass down to the right,
     274                  to edit this property in a larger window.
    265275                </para>
    266276              </listitem>
     
    301311              </term>
    302312              <listitem>
    303                 <para>Fill in any URL associated with the user here.</para>
     313                <para>An URL that is associated with the user.</para>
    304314              </listitem>
    305315            </varlistentry>
     
    312322              <listitem>
    313323                <para>
    314                   Other useful contact information or description about the user should be
    315                   written in this field. Use the magnifying glass to edit the information in
    316                   a pop-up window with a larger text-area.
     324                  Other useful contact information or description about the user
     325                  can be written in this field. Use the magnifying glass to edit
     326                  the information in a pop-up window with a larger text-area.
    317327                </para>
    318328              </listitem>
     
    340350            membership can also be changed by adding/removing the user to/from a
    341351            group's/role's list of members that is described in
    342             <link linkend="user_administration.groups.edit">edit group</link>
     352            <xref linkend="user_administration.groups.edit" />
    343353            and
    344             <link linkend="user_administration.roles.edit">edit role</link>
     354            <xref linkend="user_administration.roles.edit" />
    345355          </para>
    346356          <para>
     
    349359            or
    350360            <guibutton>Add roles&hellip;</guibutton>
    351             to add a membership in a group or a role. Mark the checkboxes for those
    352             groups or roles that the user should become a member in.
    353           </para>
    354           <para>
    355             Use
     361            to add a membership in a group or a role. Mark the check-boxes for those
     362            groups or roles that the user should become a member in. Using the
     363            <guibutton>Ok</guibutton>
     364            will add the selected items to the list of memberships.
     365          </para>
     366          <para>
     367            Memberships are removed by selecting items from the list of memberships and
     368            the pressing
    356369            <guibutton>Remove</guibutton>
    357             to delete membership(s) from selected groups and roles in the list. The
    358             selected items will then disappear from the list of memberships.
     370            . The selected items will then disappear from the list of memberships.
    359371          </para>
    360372        </sect3>
     
    377389    <title>Groups administration</title>
    378390    <para>
    379       Groups in BASE are ment to represent physical groups that are working with the program.
    380       It can be departments in an organisation or some kind of lab teams, just to mention some
    381       examples. An user's group-membership is set when the user is added to BASE and shouldn't
    382       normaly have to be changed later.
     391      Groups in BASE are meant to represent physical groups that are working with the program.
     392      It can be departments in an organization or some kind of lab teams, just to mention some
     393      examples. An user's group-membership is normally set when the user is added to BASE and
     394      has no needs to be changed later , except when the company is re-organizing.
    383395    </para>
    384396    <para>
    385397      There is one pre-installed group in BASE, a system group, called Everyone. It is, like
    386       the name says, a group in which everyone(all users) are members. The users with a role
    387       that allows sharing to everyone can easily share items to all users by using this group
    388       to share to.
     398      the name says, a group in which everyone(all users) are members. The users that are
     399      allowed to share to everyone can easily share items to all users by sharing the item to
     400      this group.
    389401    </para>
    390402
    391403    <sect2 id="user_administration.groups.edit">
    392404      <title>Edit group</title>
    393       <para></para>
     405      <para>
     406        The pop-up window where a group can be edit has two tabs,
     407        <guilabel>Group</guilabel>
     408        and
     409        <guilabel>Members</guilabel>
     410      </para>
    394411      <helptext external_id="group.edit" title="Edit group">
    395412        <sect3 id="user_administration.groups.edit.properties">
     
    412429              <listitem>
    413430                <para>
    414                   Description about the group. The magifying glass, down to the
    415                   right, can be used to open the text in a larger text area.
     431                  Description about the group. The magnifying glass, down to the
     432                  right, can be used to open and edit the text in a larger text
     433                  area.
    416434                </para>
    417435              </listitem>
     
    426444                <para>
    427445                  With this property it's possible to limit the quota of total
    428                   disk space for the group members. Select
     446                  disc space for the group members. Select
    429447                  <guilabel>-none-</guilabel>
    430                   from the dropdown list if the group shouldn't have any quota.
     448                  from the drop-down list if the group shouldn't have any quota.
    431449                  There are some presets of quotas that comes with the BASE2
    432                   installation, besides a couple with different size of total disk
     450                  installation, besides a couple with different size of total disc
    433451                  space there are one called
    434452                  <guilabel>No quota</guilabel>
     
    465483          </para>
    466484          <para>
    467             The listbox shows the group's members, both users and other groups.
     485            The list-box shows the group's members, both users and other groups.
    468486
    469487            Removing members from a group are done by first select one or several
     
    491509    <para>
    492510      Roles are different kinds of working positions that users can have, like server
    493       adminstrator or regular user just to mention two. The permissions for a role are set
     511      administrator or regular user just to mention two. The permissions for a role are set
    494512      depending on what it is going to do in BASE.
    495513    </para>
    496514    <para>
    497       Users are normally assigned a role, perhaps more then one, when they are
    498       created and registered in BASE.
     515      Users are normally assigned a role, perhaps more then one, when they are created and
     516      registered in BASE.
    499517    </para>
    500518
     
    503521      <para>
    504522        Creating a new role or editing the system-roles are something that don't needs to be
    505         done very often. The existing roles will normaly be enough but there can be some
     523        done very often. The existing roles will normally be enough but there can be some
    506524        cases when they need to be complemented, either with a new role or with different
    507525        permissions.
     
    510528        <sect3 id="user_administration.roles.edit.properties">
    511529          <title>Properties</title>
    512           <para></para>
     530          <para>These are the properties that can be defined for a role.</para>
    513531          <variablelist>
    514532            <varlistentry>
     
    526544              <listitem>
    527545                <itemizedlist>
    528                   <listitem><simpara>
    529                     With
    530                     <guilabel>Share to Everyone</guilabel>
    531                     set the role is allowed to share items to the system-group
    532                     'Everyone'.</simpara>
     546                  <listitem>
     547                    <simpara>
     548                      With
     549                      <guilabel>Share to Everyone</guilabel>
     550                      set the role allows the user to share items to the
     551                      system-group 'Everyone'.
     552                    </simpara>
    533553                  </listitem>
    534                   <listitem><simpara>
    535                     <guilabel>Act as another user</guilabel>
    536                     - property makes it possible for the one with this role to
    537                     login from the menu bar as another user. This is used by job
    538                     agents when they should act as the user who started the job.</simpara>
     554                  <listitem>
     555                    <simpara>
     556                      <guilabel>Act as another user</guilabel>
     557                      - property makes it possible for the one with this role
     558                      to login from the menu bar as another user. This is used
     559                      by job agents when they should act as the user who
     560                      created the job.
     561                    </simpara>
    539562                  </listitem>
    540563                </itemizedlist>
     
    551574          </variablelist>
    552575          <para>
    553             Set the properties and procceed then to either one of the other tabs or by
     576            Set the properties and proceed then to either one of the other tabs or by
    554577            clicking on one of the buttons:
    555578            <guibutton>Save</guibutton>
     
    564587        </seeother>
    565588      </helptext>
    566      
     589
    567590      <helptext external_id="role.edit.permissions" title="Edit role permissions">
    568591        <sect3 id="user_administration.roles.edit.permissions">
     
    570593          <para>
    571594            A role's permissions are defined for each item type within BASE 2. Set the
    572             role's permission on an item type by first selecting the item(s) in the
    573             list and then tick those permissions that should be applied. Not all
    574             permissions can be applied to every item type, that's why permission
    575             checkboxes becomes disabled when selecting some of the item types
    576           </para>
    577           <para>
    578             After each item type is a string inside square brackets that shows what kind
    579             of permissions the current role has on that particular item type. The
    580             permissions that don't have been set are viewed with '-' inside the square
    581             brackets and those which have been set are represented with characters that
    582             are listed below.
    583           </para>
    584           <itemizedlist spacing="compact">
     595            role's permission on an item type by first selecting the item(s) in the list
     596            and then tick those permissions that should be applied. Not all permissions
     597            can be applied to every item type, that's why permission check-boxes becomes
     598            disabled when selecting some of the item types
     599          </para>
     600          <para>
     601            After each item type in the list is a string inside square brackets that
     602            shows what kind of permissions the current role has on that particular item
     603            type. The permissions that don't have been set are represented with '-'
     604            inside the square brackets and those which have been set are represented
     605            with characters that are listed below.
     606          </para>
     607          <itemizedlist>
    585608            <listitem>
    586609              <simpara>
    587610                <guilabel>DENIED</guilabel>
    588                 = Deny access to the selected item. This exclude all the other
     611                = Deny access to the selected item type. This exclude all the other
    589612                permissions by unchecking the other check boxes.
    590613              </simpara>
     
    634657          </itemizedlist>
    635658          <para>
    636             Set the role's permission on each one of the item types and procceed then to
     659            Set the role's permission on each one of the item types and proceed then to
    637660            one of the other tabs or click on one of the buttons:
    638661            <guibutton>Save</guibutton>
     
    647670        </seeother>
    648671      </helptext>
    649      
     672
    650673      <helptext external_id="role.edit.members" title="Role members">
    651674        <sect3 id="user_administration.roles.edit.members">
    652675          <title>Members</title>
    653676          <para>
    654             Users that are members of a role are listed in the listbox located on this
    655             tab.Members can be added or removed with the two buttons, located to the
    656             right of the listbox,
     677            Users that are members of a role are listed in the list-box located on this
     678            tab. Members can be added or removed with the two buttons, located to the
     679            right of the list box,
    657680            <guibutton>Add users&hellip;</guibutton>
    658681            and
     
    668691                  <guibutton>Add users&hellip;</guibutton>
    669692                  and select the users that should be added from the list in the
    670                   pop-up window. Press then on
     693                  pop-up window. Press then on the
    671694                  <guibutton>Ok</guibutton>
    672695                  button to close the pop-up window and add the selected users.
     
    704727      </helptext>
    705728    </sect2>
    706    
     729
    707730    <sect2 id="user_administration.roles.defaultroles">
    708731      <title>Default roles</title>
     
    748771          <listitem>
    749772            <para>
    750               A role that is suitable for any ordinary users. This allows the members
     773              A role that is suitable for all ordinary users. This allows the members
    751774              to do common things in BASE as analysis, creating biomaterials and
    752775              experiments and so on.
     
    777800    </sect2>
    778801  </sect1>
    779  
     802
    780803  <sect1 id="user_administration.quota">
    781     <title>Disk space/quota</title>
    782     <para>
    783       The administrator can control the maximum size of disk space that each user should be
    784       able to use. Also groups can have limited disk quota and this will effect when an user
    785       is saving something to the database that is disk consuming. The most restricted one of
    786       the group's quota and user's quota will be valid and the user will be denied to store
    787       the item on the server if one of the disk quotas is filled.
    788     </para>
    789     <para>
    790       More about a user's quota and quota group can be found in
     804    <title>Disc space/quota</title>
     805    <para>
     806      The administrator can control the maximum size of disc space that each user should be
     807      able to use. Also groups can have limited disc quota and this will effect when an user,
     808      that is member of a quota group, is saving something to the database that is disc
     809      consuming. The most restricted one of the group's quota and user's quota will be used
     810      and the user will be denied to store the item on the server if one of the disc quotas is
     811      filled.
     812    </para>
     813    <para>
     814      How to set an user's quota or to create a quota can be read at
    791815      <xref linkend="user_administration.groups.edit" />
    792816      and
     
    805829      <title>Edit quota</title>
    806830      <para>
    807         The edit window has two tabs, one with information about the quota and one
    808         where the limits are defined.
     831        The edit window has two tabs, one with information about the quota and one where the
     832        limits are defined.
    809833      </para>
    810834      <helptext external_id="quota.edit" title="Edit properties">
     
    828852              <listitem>
    829853                <para>
    830                   Description of the quota(Optional). It could be a good idea to
    831                   describe the quota's details here. Use the magnifying glas to
    832                   edit the text in a larger text area.
     854                  Description of the quota. It could be a good idea to
     855                  describe the quota's details here. Use the magnifying glass to
     856                  edit the text in a larger text area.(Optional)
    833857                </para>
    834858              </listitem>
     
    836860          </variablelist>
    837861          <para>
    838             Go to the other tab if there are values that haven't been set.
    839             Otherwise use
     862            Go to the other tab if there are values that haven't been set. Otherwise use
    840863            <guibutton>Save</guibutton>
    841864            to save the settings or
     
    874897              </term>
    875898              <listitem>
    876                 <para>Limit of disk space to save files in.(Optional)</para>
     899                <para>Limit of disc space to save files in.(Optional)</para>
    877900              </listitem>
    878901            </varlistentry>
     
    884907              </term>
    885908              <listitem>
    886                 <para>Disk space to save Raw data in.(Optional)</para>
     909                <para>disc space to save Raw data in.(Optional)</para>
    887910              </listitem>
    888911            </varlistentry>
     
    895918              <listitem>
    896919                <para>
    897                   Limit of disk space that can be used by experiments.(Optional)
     920                  Limit of disc space that can be used by experiments.(Optional)
    898921                </para>
    899922              </listitem>
Note: See TracChangeset for help on using the changeset viewer.