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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC 
    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
<!--
  $Id: user_administration.xml 3290 2007-05-04 14:10:27Z martin $

  Copyright (C) Authors contributing to this file.

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330,
  Boston, MA  02111-1307, USA.
-->

<chapter id="user_administration">
  <?dbhtml dir="user_administration"?>
  <title>Users/groups/roles</title>

  <sect1 id="user_administration.users">
    <title>Users administration</title>
    <para>
      The user list is accessed with
      <menuchoice>
        <guimenu>Administrate</guimenu>
        <guimenuitem>Users</guimenuitem>
      </menuchoice>
      and from here are users' account and contact information managed.
    </para>

    <sect2 id="user_administration.users.edit">
      <title>Edit user</title>
      <para>
        The edit pop-up window is the same for both when creating a new user and when
        editing an existing user.
      </para>

      <helptext external_id="user.edit" title="Edit user account">
        <sect3 id="user_administration.users.edit.account">
          <title>Account properties</title>
          <para>
            These are the properties for an user account.
          </para>
          <variablelist>
            <varlistentry>
              <term>
                <userinput>Name</userinput>
              </term>
              <listitem>
                <para>
                  The full name of the user that is associated with this account.
                  (Required)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <userinput>Login</userinput>
              </term>
              <listitem>
                <para>
                  A login name to use when logging in to this account. (Required)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>External ID</userinput>
                </optional>
              </term>
              <listitem>
                <para>Id used identify the user outside BASE. (Optional)</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <userinput>New password</userinput>
              </term>
              <listitem>
                <para>
                  This is used together with the login name to log in with this
                  account. This is required for a new user or if the password
                  should be changed.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <userinput>Retype password</userinput>
              </term>
              <listitem>
                <para>
                  Retype the password in <guilabel>New password</guilabel>.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Quota</userinput>
                </optional>
              </term>
              <listitem>
                <para>Set disk quota for this account.(Required)</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Quota group</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  Set this if the account should belong to a group with specified
                  quota.(Optional)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Home directory</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  Set the account's home directory. A new directory, either empty
                  or from a template, can be created if editing a new
                  user.(Optional)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Expiration date</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  Define a date in this field if the account should expire on a
                  certain day. It will not be possible to log in to BASE after
                  this date. Use
                  <guibutton>Calendar&hellip;</guibutton>
                  to pick a date from a calendar-pop-up window.(Optional)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <userinput>Multi-user account</userinput>
              </term>
              <listitem>
                <para>
                  This checkbox should be ticked if the account should be used by
                  more one user. It will block the users of the account to change
                  password, contact information and other personal information.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <userinput>Disabled</userinput>
              </term>
              <listitem>
                <para>
                  Ticking this checkbox will disabled the account and it won't be
                  possible to use it.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </sect3>
        <para>
          Go to the other tabs if there are any changes to do otherwise press
          <guibutton>Save</guibutton>
          to save the values or
          <guibutton>Cancel</guibutton>
          to abort.
        </para>
        <seeother>
          <other external_id="user.edit.contact">Edit user's contact information</other>
          <other external_id="user.edit.membership">Edit user's membership</other>
        </seeother>
      </helptext>
      <helptext external_id="user.edit.contact" title="Edit user's contact information">
        <sect3 id="user._administration.users.edit.contact">
          <title>Contact information</title>
          <para>
            Information how get in contact with the user that is connected to the
            account. All fields on this tab are optional and do not necessarily need to
            have a value.
          </para>
          <variablelist>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Email</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  User's email address.There is some verification of the value but
                  their is no check if the email really exists.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Organisation</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  The company or organisation that the user works for.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Address</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  User's address. Use the magnifying glas down to the right, to
                  edit this property in a larger window - opened in a pop-up
                  window.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Phone</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  User's phone number(s)
                  <note>
                    <para>
                      There is no special field for mobile phone, but it works
                      fine to put more then one number in this field.
                    </para>
                  </note>
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Fax</userinput>
                </optional>
              </term>
              <listitem>
                <para>User's fax number.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Url</userinput>
                </optional>
              </term>
              <listitem>
                <para>Fill in any URL associated with the user here.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Description</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  Other useful contact information or description about the user should be
                  written in this field. Use the magnifying glass to edit the information in
                  a pop-up window with a larger text-area.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </sect3>
        <para>
          Go to the other tabs if there are any changes to do otherwise press
          <guibutton>Save</guibutton>
          to save the values or
          <guibutton>Cancel</guibutton>
          to abort.
        </para>
        <seeother>
          <other external_id="user.edit">Edit account</other>
          <other external_id="user.edit.membership">Edit user's membership</other>
        </seeother>
      </helptext>

      <helptext external_id="user.edit.membership" title="Edit user's membership">
        <sect3 id="user_administration.users.edit.membership">
          <title>User's membership</title>
          <para></para>
          <sect4 id="user_administration.users.edit.membership.change">
            <title>Add or remove membership</title>
            <para >
              An user's membership in groups and roles can be set on this tab. The
              membership can also be changed by adding/removing the user to/from a
              group's/role's list of members that is described in
              <link linkend="user_administration.groups.edit">edit group</link>
              and
              <link linkend="user_administration.roles.edit">edit role</link>
            </para>
            <para>
              Use
              <guibutton>Add groups&hellip;</guibutton>
              or
              <guibutton>Add roles&hellip;</guibutton>
              to add a membership in a group or a role. Mark the checkboxes for those
              groups or roles that the user should become a member in.
            </para>
            <para>
              Use
              <guibutton>Remove</guibutton>
              to delete membership(s) from selected groups/roles in the list. The
              selected items will disappear from the list of memberships.
            </para>
          </sect4>
        </sect3>
        <para>
          Go to the other tabs if there are any changes to do otherwise press
          <guibutton>Save</guibutton>
          to save the values or
          <guibutton>Cancel</guibutton>
          to abort.
        </para>
        <seeother>
          <other external_id="user.edit">Edit account</other>
          <other external_id="user.edit.contact">Edit user's contact information</other>
        </seeother>
      </helptext>
    </sect2>
  </sect1>

  <sect1 id="user_administration.groups">
    <title>Groups administration</title>
    <para></para>

    <sect2 id="user_administration.groups.edit">
      <title>Edit group</title>
      <para></para>
      <helptext external_id="group.edit" title="Edit group">
        <sect3 id="user_administration.groups.edit.properties">
          <title>Properties</title>
          <variablelist>
            <varlistentry>
              <term>
                <userinput>Name</userinput>
              </term>
              <listitem>
                <para>Group's name.(Required)</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Description</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  Description about the group. The magifying glass, down to the
                  right, can be used to open the text in a larger text area.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <optional>
                  <userinput>Quota</userinput>
                </optional>
              </term>
              <listitem>
                <para>
                  With this property it's possible to limit the quota of total
                  disk space for the group members. Select
                  <guilabel>-none-</guilabel>
                  from the dropdown list if the group shouldn't be a quota group.
                  There are some presets of quotas that comes with the BASE2
                  installation, besides a couple with different size of total disk
                  space there are one called
                  <guilabel>No quota</guilabel>
                  and one with
                  <guilabel>Unlimited quota</guilabel>
                  . The names speak for them self.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </sect3>
        <para>
          Go to the other tab,
          <guilabel>Members</guilabel>
          , if there are any changes to do otherwise press
          <guibutton>Save</guibutton>
          to save the values or
          <guibutton>Cancel</guibutton>
          to abort.
        </para>
        <seeother>
          <other external_id="group.edit.membership">Edit group members</other>
        </seeother>
      </helptext>
      
      <helptext external_id="group.edit.membership" title="Edit group members">
        <sect3 id="user_administration.groups.edit.members">
          <title>Group members</title>
          <para>
            The members in a group can be both users and other groups. Group members
            have access to those items that are shared to the group. Each user in the
            group can choose to share their own items to one or more of the other
            members or to the whole group.
          </para>
          <sect4 id="user_administration.groups.edit.members.change">
            <title>Members</title>
            <para>
              The members of a group are displayed in the members listbox. Press Save
              to save the settings or Cancel to abort and discard the changes.

              Add users/groups Click on either Add users... - to add users or Add
              groups... - to add whole groups to the member list. This will open a
              popup window where the new members can be selected.

              Remove members Removing a member from a group are done by first
              selecting one or more member in the list and then press Remove.
            </para>
          </sect4>
        </sect3>
        <para>
          Go to the other tab,
          <guilabel>Group</guilabel>
          , if there are any changes to do otherwise press
          <guibutton>Save</guibutton>
          to save the values or
          <guibutton>Cancel</guibutton>
          to abort.
        </para>
        <seeother>
          <other external_id="group.edit">Edit group properties</other>
        </seeother>
      </helptext>
    </sect2>

  </sect1>

  <sect1 id="user_administration.roles">
    <title>Roles administration</title>
    <para></para>

    <sect2 id="user_administration.roles.edit">
      <title>Edit role</title>
      <para></para>
    </sect2>
  </sect1>
  
  <sect1 id="user_administration.quota">
    <title>Disk space/quota</title>
    <para></para>
  </sect1>
</chapter>