Changeset 3300


Ignore:
Timestamp:
May 7, 2007, 5:08:27 PM (14 years ago)
Author:
Martin Svensson
Message:

References #549. More text, mainly about groups and roles

File:
1 edited

Legend:

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

    r3290 r3300  
    2929<chapter id="user_administration">
    3030  <?dbhtml dir="user_administration"?>
    31   <title>Users/groups/roles</title>
     31  <title>Account administration</title>
    3232
    3333  <sect1 id="user_administration.users">
     
    4343
    4444    <sect2 id="user_administration.users.edit">
    45       <title>Edit user</title>
    46       <para>
    47         The edit pop-up window is the same for both when creating a new user and when
    48         editing an existing user.
    49       </para>
     45      <title>Edit user</title>     
    5046
    5147      <helptext external_id="user.edit" title="Edit user account">
    52         <sect3 id="user_administration.users.edit.account">
    53           <title>Account properties</title>
     48        <sect3 id="user_administration.users.edit.properties">
     49          <title>Properties</title>
    5450          <para>
    5551            These are the properties for an user account.
     
    5854            <varlistentry>
    5955              <term>
    60                 <userinput>Name</userinput>
     56                <guilabel>Name</guilabel>
    6157              </term>
    6258              <listitem>
     
    6965            <varlistentry>
    7066              <term>
    71                 <userinput>Login</userinput>
     67                <guilabel>Login</guilabel>
    7268              </term>
    7369              <listitem>
     
    8076              <term>
    8177                <optional>
    82                   <userinput>External ID</userinput>
     78                  <guilabel>External ID</guilabel>
    8379                </optional>
    8480              </term>
     
    8985            <varlistentry>
    9086              <term>
    91                 <userinput>New password</userinput>
     87                <guilabel>New password</guilabel>
    9288              </term>
    9389              <listitem>
     
    10197            <varlistentry>
    10298              <term>
    103                 <userinput>Retype password</userinput>
     99                <guilabel>Retype password</guilabel>
    104100              </term>
    105101              <listitem>
     
    112108              <term>
    113109                <optional>
    114                   <userinput>Quota</userinput>
     110                  <guilabel>Quota</guilabel>
    115111                </optional>
    116112              </term>
     
    122118              <term>
    123119                <optional>
    124                   <userinput>Quota group</userinput>
     120                  <guilabel>Quota group</guilabel>
    125121                </optional>
    126122              </term>
     
    135131              <term>
    136132                <optional>
    137                   <userinput>Home directory</userinput>
     133                  <guilabel>Home directory</guilabel>
    138134                </optional>
    139135              </term>
     
    149145              <term>
    150146                <optional>
    151                   <userinput>Expiration date</userinput>
     147                  <guilabel>Expiration date</guilabel>
    152148                </optional>
    153149              </term>
     
    155151                <para>
    156152                  Define a date in this field if the account should expire on a
    157                   certain day. It will not be possible to log in to BASE after
    158                   this date. Use
    159                   <guibutton>Calendar&hellip;</guibutton>
    160                   to pick a date from a calendar-pop-up window.(Optional)
    161                 </para>
    162               </listitem>
    163             </varlistentry>
    164             <varlistentry>
    165               <term>
    166                 <userinput>Multi-user account</userinput>
     153                  certain day. The account will be disabled after this
     154                  date.(Optional)
     155                  <tip>
     156                    <para>
     157                      Use
     158                      <guibutton>Calendar&hellip;</guibutton>
     159                      to pick a date from a calendar-pop-up window.
     160                    </para>
     161                  </tip>
     162                </para>
     163              </listitem>
     164            </varlistentry>
     165            <varlistentry>
     166              <term>
     167                <guilabel>Multi-user account</guilabel>
    167168              </term>
    168169              <listitem>
     
    176177            <varlistentry>
    177178              <term>
    178                 <userinput>Disabled</userinput>
    179               </term>
    180               <listitem>
    181                 <para>
    182                   Ticking this checkbox will disabled the account and it won't be
    183                   possible to use it.
     179                <guilabel>Disabled</guilabel>
     180              </term>
     181              <listitem>
     182                <para>
     183                  Disable the account to be used.
    184184                </para>
    185185              </listitem>
     
    211211              <term>
    212212                <optional>
    213                   <userinput>Email</userinput>
     213                  <guilabel>Email</guilabel>
    214214                </optional>
    215215              </term>
     
    224224              <term>
    225225                <optional>
    226                   <userinput>Organisation</userinput>
     226                  <guilabel>Organisation</guilabel>
    227227                </optional>
    228228              </term>
     
    236236              <term>
    237237                <optional>
    238                   <userinput>Address</userinput>
     238                  <guilabel>Address</guilabel>
    239239                </optional>
    240240              </term>
     
    250250              <term>
    251251                <optional>
    252                   <userinput>Phone</userinput>
     252                  <guilabel>Phone</guilabel>
    253253                </optional>
    254254              </term>
     
    268268              <term>
    269269                <optional>
    270                   <userinput>Fax</userinput>
     270                  <guilabel>Fax</guilabel>
    271271                </optional>
    272272              </term>
     
    278278              <term>
    279279                <optional>
    280                   <userinput>Url</userinput>
     280                  <guilabel>Url</guilabel>
    281281                </optional>
    282282              </term>
     
    288288              <term>
    289289                <optional>
    290                   <userinput>Description</userinput>
     290                  <guilabel>Description</guilabel>
    291291                </optional>
    292292              </term>
     
    317317        <sect3 id="user_administration.users.edit.membership">
    318318          <title>User's membership</title>
    319           <para></para>
    320           <sect4 id="user_administration.users.edit.membership.change">
    321             <title>Add or remove membership</title>
    322             <para >
    323               An user's membership in groups and roles can be set on this tab. The
    324               membership can also be changed by adding/removing the user to/from a
    325               group's/role's list of members that is described in
    326               <link linkend="user_administration.groups.edit">edit group</link>
    327               and
    328               <link linkend="user_administration.roles.edit">edit role</link>
    329             </para>
    330             <para>
    331               Use
    332               <guibutton>Add groups&hellip;</guibutton>
    333               or
    334               <guibutton>Add roles&hellip;</guibutton>
    335               to add a membership in a group or a role. Mark the checkboxes for those
    336               groups or roles that the user should become a member in.
    337             </para>
    338             <para>
    339               Use
    340               <guibutton>Remove</guibutton>
    341               to delete membership(s) from selected groups/roles in the list. The
    342               selected items will disappear from the list of memberships.
    343             </para>
    344           </sect4>
     319          <para>
     320            An user's membership in groups and roles can be set on this tab. The
     321            membership can also be changed by adding/removing the user to/from a
     322            group's/role's list of members that is described in
     323            <link linkend="user_administration.groups.edit">edit group</link>
     324            and
     325            <link linkend="user_administration.roles.edit">edit role</link>
     326          </para>
     327          <para>
     328            Use
     329            <guibutton>Add groups&hellip;</guibutton>
     330            or
     331            <guibutton>Add roles&hellip;</guibutton>
     332            to add a membership in a group or a role. Mark the checkboxes for those
     333            groups or roles that the user should become a member in.
     334          </para>
     335          <para>
     336            Use
     337            <guibutton>Remove</guibutton>
     338            to delete membership(s) from selected groups and roles in the list. The
     339            selected items will then disappear from the list of memberships.
     340          </para>
    345341        </sect3>
    346342        <para>
     
    372368            <varlistentry>
    373369              <term>
    374                 <userinput>Name</userinput>
     370                <guilabel>Name</guilabel>
    375371              </term>
    376372              <listitem>
     
    381377              <term>
    382378                <optional>
    383                   <userinput>Description</userinput>
     379                  <guilabel>Description</guilabel>
    384380                </optional>
    385381              </term>
     
    394390              <term>
    395391                <optional>
    396                   <userinput>Quota</userinput>
     392                  <guilabel>Quota</guilabel>
    397393                </optional>
    398394              </term>
     
    433429          <title>Group members</title>
    434430          <para>
    435             The members in a group can be both users and other groups. Group members
    436             have access to those items that are shared to the group. Each user in the
    437             group can choose to share their own items to one or more of the other
     431            A group can have both single users and whole groups as members. Group
     432            members have access to those items that are shared to the group. Each user
     433            in the group can choose to share their own items to one or more of the other
    438434            members or to the whole group.
    439435          </para>
    440           <sect4 id="user_administration.groups.edit.members.change">
    441             <title>Members</title>
    442             <para>
    443               The members of a group are displayed in the members listbox. Press Save
    444               to save the settings or Cancel to abort and discard the changes.
    445 
    446               Add users/groups Click on either Add users... - to add users or Add
    447               groups... - to add whole groups to the member list. This will open a
    448               popup window where the new members can be selected.
    449 
    450               Remove members Removing a member from a group are done by first
    451               selecting one or more member in the list and then press Remove.
    452             </para>
    453           </sect4>
     436          <para>
     437            The listbox shows the group's members, both users and other groups.
     438
     439            Removing members from a group are done by first select one or several
     440            members in the list and then click on
     441            <guibutton>Remove</guibutton>
     442            . The selected items will then disappear from the list.
     443          </para>
    454444        </sect3>
    455445        <para>
    456           Go to the other tab,
    457           <guilabel>Group</guilabel>
    458           , if there are any changes to do otherwise press
     446          Go to the group tab if there are any changes to do, otherwise press
    459447          <guibutton>Save</guibutton>
    460448          to save the values or
     
    473461    <title>Roles administration</title>
    474462    <para></para>
     463    <sect2 id="user_administration.roles.defaultroles">
     464      <title>Default roles</title>
     465      <para>
     466        There some default roles that come with BASE2. These are configured to cover the
     467        normal user roles that can appear. A more detailed description of the different
     468        roles and when to use them follows here.
     469      </para>
     470      <variablelist>
     471        <varlistentry>
     472          <term>Administrator</term>
     473          <listitem>
     474            <para>
     475              This role gives the user full permission to everything in BASE and also
     476              possibility to share items with the system-group 'Everyone'. Users that
     477              are supposed to administrate the server, users accounts, groups etc.
     478              should have this role.
     479            </para>
     480          </listitem>
     481        </varlistentry>
     482        <varlistentry>
     483          <term>Supervisor</term>
     484          <listitem>
     485            <para>
     486              Users that are members of this role has permission to read everything in
     487              BASE.This role doesn't let the members to actually do anything in BASE
     488              except read.
     489            </para>
     490          </listitem>
     491        </varlistentry>
     492        <varlistentry>
     493          <term>Power user</term>
     494          <listitem>
     495            <para>
     496              This role allows it's members to do some things that an ordinary user
     497              not is allowed to. This role can be proper for those users that are in
     498              some kind of leading position over workgroups or projects.
     499            </para>
     500          </listitem>
     501        </varlistentry>
     502        <varlistentry>
     503          <term>User</term>
     504          <listitem>
     505            <para>
     506              Role for regular users to have. This allows the members to do common
     507              things in BASE as analysis, creating biomaterials and experiments and so
     508              on.
     509            </para>
     510          </listitem>
     511        </varlistentry>
     512      </variablelist>
     513    </sect2>
    475514
    476515    <sect2 id="user_administration.roles.edit">
    477516      <title>Edit role</title>
    478517      <para></para>
     518      <helptext external_id="role.edit" title="Edit role">
     519        <sect3 id="user_administration.roles.edit.properties">
     520          <title>Properties</title>
     521          <para></para>
     522          <variablelist>
     523            <varlistentry>
     524              <term>
     525                <guilabel>Name</guilabel>
     526              </term>
     527              <listitem>
     528                <para>The name of the role. (Required)</para>
     529              </listitem>
     530            </varlistentry>
     531            <varlistentry>
     532              <term>
     533                <guilabel>System-level permissions</guilabel>
     534              </term>
     535              <listitem>
     536                <itemizedlist>
     537                  <listitem>
     538                    <para>
     539                      With
     540                      <guilabel>Share to Everyone</guilabel>
     541                      set the role is allowed to share items to the
     542                      system-group 'Everyone'.
     543                    </para>
     544                  </listitem>
     545                  <listitem>
     546                    <para>
     547                      <guilabel>Act as another user</guilabel>
     548                      - property makes it possible for the one with this role
     549                      to login from the menu bar as another user. This is used
     550                      by job agents when they should act as the user who
     551                      started the job.
     552                    </para>
     553                  </listitem>
     554                </itemizedlist>
     555              </listitem>
     556            </varlistentry>
     557            <varlistentry>
     558              <term>
     559                <guilabel>Description</guilabel>
     560              </term>
     561              <listitem>
     562                <para>Description and information about the role.(Optional)</para>
     563              </listitem>
     564            </varlistentry>
     565          </variablelist>
     566          <para>
     567            Set the properties and procceed then to either one of the other tabs or by
     568            clicking on one of the buttons:
     569            <guibutton>Save</guibutton>
     570            to save the changes or
     571            <guibutton>Cancel</guibutton>
     572            to abort.
     573          </para>
     574        </sect3>
     575        <seeother>
     576          <other external_id="role.edit.permissions">Role permissions</other>
     577          <other external_id="role.edit.members">Role members</other>
     578        </seeother>
     579      </helptext>
     580     
     581      <helptext external_id="role.edit.permissions" title="Edit role permissions">
     582        <sect3 id="user_administration.roles.edit.permissions">
     583          <title>Permissions</title>
     584          <para>
     585            A role's permissions are defined for each item type within BASE 2. Set the
     586            role's permission on an item type by first selecting the item(s) in the
     587            list and then tick those permissions that should be applied. Not all
     588            permissions can be applied to every item type, that's why permission
     589            checkboxes becomes disabled when selecting some of the item types
     590          </para>
     591          <para>
     592            After each item type is a string inside square brackets that shows what kind
     593            of permissions the current role has on that particular item type. The
     594            permissions that don't have been set are viewed with '-' inside the square
     595            brackets and those which have been set are represented with characters that
     596            are listed below.
     597          </para>
     598          <itemizedlist  spacing="compact">
     599            <listitem>
     600                <guilabel>DENIED</guilabel>
     601                = Deny access to the selected item. This exclude all the other
     602                permissions by unchecking the other check boxes.
     603            </listitem>
     604            <listitem>
     605                <guilabel>C</guilabel>
     606                = Create
     607            </listitem>
     608            <listitem>
     609                <guilabel>R</guilabel>
     610                = Read
     611            </listitem>
     612            <listitem>
     613                <guilabel>U</guilabel>
     614                = Use
     615            </listitem>
     616            <listitem>
     617                <guilabel>W</guilabel>
     618                = Write
     619            </listitem>
     620            <listitem>
     621                <guilabel>D</guilabel>
     622                = Delete
     623            </listitem>
     624            <listitem>
     625                <guilabel>O</guilabel>
     626                = Take ownership
     627            </listitem>
     628            <listitem>
     629                <guilabel>P</guilabel>
     630                = Set permission
     631            </listitem>
     632          </itemizedlist>
     633          <para>
     634            Set the role's permission on each one of the item types and procceed then to
     635            one of the other tabs or click on one of the buttons:
     636            <guibutton>Save</guibutton>
     637            to save the changes or
     638            <guibutton>Cancel</guibutton>
     639            to abort.
     640          </para>
     641        </sect3>
     642        <seeother>
     643          <other external_id="role.edit">Edit properties</other>
     644          <other external_id="role.edit.mebers">Role members</other>
     645        </seeother>
     646      </helptext>
     647     
     648      <helptext external_id="role.edit.members" title="Role members">
     649        <sect3>
     650          <title>Members</title>
     651          <para>
     652            Users that are members of a role are listed in the listbox located on this
     653            tab.Members can be added or removed with the two buttons, located to the
     654            right of the listbox,
     655            <guibutton>Add users&hellip;</guibutton>
     656            and
     657            <guibutton>Remove</guibutton>
     658            .
     659          </para>
     660          <variablelist>
     661            <varlistentry>
     662              <term>Add users to list</term>
     663              <listitem>
     664                <para>
     665                  Click on
     666                  <guibutton>Add users&hellip;</guibutton>
     667                  and select the users that should be added from the list in the
     668                  pop-up window. Press then on
     669                  <guibutton>Ok</guibutton>
     670                  button to close the pop-up window and add the selected users.
     671                  Use
     672                  <guibutton>Cancel</guibutton>
     673                  or just close the pop-up to abort and return to main window.
     674                </para>
     675              </listitem>
     676            </varlistentry>
     677            <varlistentry>
     678              <term>Remove users from list</term>
     679              <listitem>
     680                <para>
     681                  Members are removed from the list by first selecting them and
     682                  then pressing
     683                  <guibutton>Remove</guibutton>
     684                  . The selected user(s) are removed immediately.
     685                </para>
     686              </listitem>
     687            </varlistentry>
     688          </variablelist>
     689          <para>
     690            Press
     691            <guibutton>Save</guibutton>
     692            to save the role or go to one of the other tabs if there are more that needs
     693            to be set. Use
     694            <guibutton>Close</guibutton>
     695            to abort and close the window without saving the changes.
     696          </para>
     697        </sect3>
     698        <seeother>
     699          <other external_id="role.edit">Edit properties</other>
     700          <other external_id="role.edit.permissions">Role permissions</other>
     701        </seeother>
     702      </helptext>
    479703    </sect2>
    480704  </sect1>
Note: See TracChangeset for help on using the changeset viewer.