<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
        <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent">
        %BOOK_ENTITIES;
        ]>
<section id="sect-User_Guide-User_management">
  <title>Manage Users and Groups</title>
  <para>
    Several tools are offered to assist Administrators manage users, groups and memberships easily and effectively.
  </para>
  <para>You first need to:</para>
  <itemizedlist>
    <listitem>
      <para>
        Mouse-over
        <emphasis role="bold">Group</emphasis>
        in the <emphasis role="bold">Toolbar</emphasis>.
      </para>
    </listitem>
    <listitem>
      <para>
        Highlight
        <emphasis role="bold">Organization</emphasis>
        and then click <emphasis role="bold">Users and groups management</emphasis>.
      </para>
    </listitem>
  </itemizedlist>

  <!--
 <menuchoice>
   <guimenu>Group</guimenu>
   <guimenuitem>Organization</guimenuitem>
   <guimenuitem>Users and groups management</guimenuitem>
 </menuchoice> -->

  <mediaobject>
    <imageobject role="html">
      <imagedata fileref="images/UserGroupManagement.png" format="PNG" align="center" scale="1" contentwidth="70"/>
    </imageobject>
    <imageobject role="fo">
      <imagedata fileref="images/UserGroupManagement.png" format="PNG" align="center" contentwidth="100mm"/>
    </imageobject>
  </mediaobject>
  <para>The Organization form will be shown that enables you to manage users, groups and memberships.</para>

  <section id="sect-User_Guide-User_Management-Manage_users">
    <title>Manage users</title>
    <para>
      As an administrator, you can easily find, edit information of user via the
      <guilabel>User Management</guilabel>
      tab in the
      <emphasis role="bold">Organization</emphasis>
      form. By default, all existing registered users will shown:
    </para>
    <mediaobject>
      <imageobject>
        <imagedata fileref="images/UserManage.png" format="PNG" align="center" width="444"/>
      </imageobject>
    </mediaobject>
    <para>
      Administrators can see all existing registered users and search, edit or even delete them. Each user's groups and
      memberships (roles) in these groups are also available. You cannot add users to a group but you can remove them
      from the group.
    </para>


    <section id="sect-User_Guide-User_Management-Add_a_user">
      <title>Add a user</title>
      <para>
        To add a new user to the portal user lists follow these steps:
      </para>
      <procedure>
        <step>
          <para>
            Mouse-over
            <emphasis role="bold">Group</emphasis>
            in the <emphasis role="bold">Toolbar</emphasis>.
          </para>
        </step>
        <step>
          <para>
            Highlight
            <emphasis role="bold">Organization</emphasis>
            and then click <emphasis role="bold">New Staff</emphasis>.
          </para>
          <para>
            The
            <emphasis role="bold">New Staff</emphasis>
            window will open:
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/NewStaff.png" format="PNG" align="center" scale="110"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/NewStaff.png" format="PNG" align="center" contentwidth="150mm"/>
            </imageobject>
          </mediaobject>
          <para>
            This window has two tabs:
            <emphasis role="bold">Account Settings</emphasis>
            and<emphasis role="bold">User Profile</emphasis>.
          </para>
        </step>
        <step>
          <para>
            To create a new user all of the fields in the
            <emphasis role="bold">Account Settings</emphasis>
            tab must be completed.
          </para>
          <para>
            Further information about the user (such as nickname and birthday) can be added in the
            <emphasis role="bold">User Profile</emphasis>
            tab. This information is not required for the creation of the account.
          </para>
        </step>
        <step>
          <para>
            Click either
            <emphasis role="bold">Save</emphasis>
            or
            <emphasis role="bold">Reset</emphasis>
            to create or discard the new account.
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Search_a_user">
      <title>Search for users</title>
      <para>
        The Administrator can search for specific users by username, first name, last name or email address.
      </para>
      <procedure>
        <step>
          <para>
            Select the information type (name, email, etc) to search against
          </para>
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/SearchUser.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Type in a partial/full string which identifies the user record being searched. Note that wild cards are not
            supported at this release.
          </para>
        </step>
        <step>
          <para>
            Click the magnifying glass icon to begin the search.
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Edit_a_user">
      <title>Edit user information</title>
      <procedure>
        <step>
          <para>
            Locate the user you wish to edit.
          </para>
        </step>
        <step>
          <para>
            Click the edit icon (next to the trash icon).
          </para>
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/Demo1.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Select the
            <emphasis role="bold">Account Info</emphasis>
            tab to edit the main user information set including first name, last name or email address.
          </para>
          <variablelist>
            <varlistentry>
              <term>User Name</term>
              <listitem>
                <para>
                  The
                  <emphasis role="bold">User Name</emphasis>
                  field cannot be changed. Other fields
                  <emphasis role="bold">First Name</emphasis>
                  ,
                  <emphasis role="bold">Last Name</emphasis>
                  ,
                  <emphasis role="bold">Email Address</emphasis>
                  can be changed.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>Change Password</term>
              <listitem>
                <para>
                  The
                  <emphasis role="bold">Change Password</emphasis>
                  option allows an administrator to set a new password for a user. When the
                  <emphasis role="bold">Change Password</emphasis>
                  option is unchecked,
                  <emphasis role="bold">New Password</emphasis>
                  and
                  <emphasis role="bold">Confirm Password</emphasis>
                  are hidden. Passwords must contain at least 6 characters and can contain letters, numbers and
                  punctuation marks.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </step>
        <step>
          <para>
            Select the
            <emphasis role="bold">User Profile</emphasis>
            tab to edit additional information about the user's profile such as the birthdate or the job title as well
            as some home and business metadata. You may also switch the default display language for that user.
          </para>
        </step>
        <step>
          <para>
            Select the
            <emphasis role="bold">User Membership</emphasis>
            tab to see a user's group membership information.
          </para>
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/Demo3.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
          <variablelist>
            <varlistentry>
              <term>User Membership</term>
              <listitem>
                <para>
                  The
                  <emphasis role="bold">User Membership</emphasis>
                  tab displays which group(s) the selected user belongs to. In the above figure, the user "demo" is a
                  member of two groups: "guests" and "users". The parent group of both is "platform".
                </para>
                <para>
                  To remove the user from a group, click the trash can icon.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </step>
        <step>
          <para>
            Click the <emphasis role="bold">Save</emphasis>.
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Delete_a_user">
      <title>Delete a user</title>
      <procedure>
        <step>
          <para>
            Locate the user you wish to delete
          </para>
        </step>
        <step>
          <para>
            Click the trash icon corresponding to the user who you want to delete in the main User Management form.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">OK</emphasis>
            to confirm.
          </para>
        </step>
      </procedure>
    </section>

  </section>

  <section id="sect-User_Guide-User_Management-Manage_groups">
    <title>Manage groups</title>
    <para>Select the
      <emphasis>Group Management</emphasis>
      tab in the Organization form. This tab is used to add new, edit or delete a group.
    </para>
    <para>
      By default, all existing groups will be displayed on the left pane. This tab is used to add new, edit or delete a
      group. The right pane shows information about the selected group including information about the members in the
      specific group along with a small form to add a new user to a group.
    </para>
    <mediaobject>
      <imageobject>
        <imagedata fileref="images/GroupManage.png" format="PNG" align="center" width="444"/>
      </imageobject>
    </mediaobject>

    <section id="sect-User_Guide-User_Management-Add_a_new_group">
      <title>Add a New Group</title>
      <procedure>
        <step>
          <para>
            Choose the path to create a new group by selecting the group from the list on the left pane or by clicking
            <inlinemediaobject>
              <mediaobject>
              <imageobject role="html">
                <imagedata fileref="images/arrow-blue-arrow.png" format="PNG"/>
              </imageobject>
              </mediaobject>
            </inlinemediaobject>
            if you want to create a group at a higher level. The selected path is displayed in the breadcrumb bar.
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/Admin1.png" format="PNG" align="center"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/Admin1.png" format="PNG" align="center" contentwidth="50mm"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Click
            <inlinemediaobject>
              <mediaobject>
              <imageobject role="html">
                <imagedata fileref="images/plus-icon.png" format="PNG"/>
              </imageobject>
              </mediaobject>
            </inlinemediaobject>
            in the left pane. The
            <emphasis role="bold">Add New Group</emphasis>
            form will be displayed on the right pane.
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/AddGroup.png" format="PNG" align="center" width="444"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/AddGroup.png" format="PNG" align="center" contentwidth="110mm"/>
            </imageobject>
          </mediaobject>
          <variablelist>
            <varlistentry>
              <term>
                <emphasis role="bold">Group Name</emphasis>
              </term>
              <listitem>
                <para>
                  The name of the new group. This field is required and any length from 3 to 30 characters is allowed.
                  Once saved this name cannot be edited.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <emphasis role="bold">Label</emphasis>
              </term>
              <listitem>
                <para>
                  The display name of the group. Any length from 3 to 30 characters is allowed.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <emphasis role="bold">Description</emphasis>
              </term>
              <listitem>
                <para>
                  A description of the group. Any length from 3 to 30 characters is allowed.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </step>
        <step>
          <para>
            Fill in the required fields. Only letters, numbers and underscore characters are allowed for the
            <emphasis role="bold">Group Name</emphasis>
            field. The name must be unique within the portal.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">Save</emphasis>
          </para>
        </step>
      </procedure>
      <note>
        <para>When a new group is added, the group creator will become the manager of that group. The creator's username
          will be added in the created group with the "manager" membership.
        </para>
      </note>
    </section>

    <section id="sect-User_Guide-User_Management-Edit-a-group">
      <title>Edit a group</title>
      <procedure>
        <step>
          <para>
            Find the group in the existing tree and click the label
          </para>
        </step>
        <step>
          <para>
            Click the edit icon to display the
            <emphasis role="bold">Edit Current Group</emphasis>
            window.
          </para>
        </step>
        <step>
          <para>
            Make the desired changes in the appropriate fields. You can not change the Group Name, however you may
            change to the
            <emphasis role="bold">Label</emphasis>
            field. You are also able to edit the
            <emphasis role="bold">Description</emphasis>
            field.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">Save</emphasis> to accept changes.
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Add_a_new_user_to_a_group">
      <title>Add a new user to a group</title>
      <procedure>
        <step>
          <para>
            Find the group in the existing tree and click its label. Existing group memberships are listed on the
            left hand side along with the
            <emphasis role="bold">Add Member</emphasis>
            window.
          </para>
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/AddMember1.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Click the magnify glass to open up the User selector.
          </para>
          <para>
            Refer to
            <xref linkend="sect-User_Guide-User_Management-Search_a_user"/>
            for instructions on how to locate a user.
          </para>
          <para>
            Check the box next to the user name then click
            <emphasis role="bold">Add</emphasis>.
          </para>
        </step>
        <step>
          <para>
            Select the membership appropriate for this user. If the desired membership does not appear you may try to
            click the refresh icon to get the latest list.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">Save</emphasis> to accept adding the selected user to a specific group with the selected membership type.
          </para>
        </step>
      </procedure>
      <note><para>By default, the 'manager" membership has the highest right in a group.
A user can have several membership types in a group. To do that, you have to use the <emphasis role="bold">Add member</emphasis> form for each membership type.
After adding, the user's membership information is also updated. You can check it by opening the <emphasis role="bold">User Management</emphasis> form and editing the user you just added.</para></note>
    </section>

    <section id="sect-User_Guide-User_Management-Edit_the_user_membership_in_a_group">
      <title>Edit the user membership in a group</title>
      <procedure>
        <step>
          <para>
            Click the edit icon corresponding to a specific user with a membership in the Action column.
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/EditMember1.png" format="PNG" align="center"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/EditMember1.png" format="PNG" align="center" contentwidth="90mm"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Select a membership type in the <guilabel>Membership</guilabel> drop-down list.
          </para>
        </step>
        <step>
          <para>
            Click <emphasis role="bold">Save</emphasis> to accept adding a new membership, or <guibutton>Reset</guibutton> to clear entered values..
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Delete_a_group">
      <title>Delete a group</title>
      <procedure>
        <step>
          <para>
            Find the group in the tree
          </para>
        </step>
        <step>
          <para>
            Click the trash icon in the row of the membership type you want to delete..
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" scale="110"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" contentwidth="150mm"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Click<emphasis role="bold">OK</emphasis> .
          </para>
        </step>
      </procedure>
      <note>
        <para>After being deleted, all information related to that group, such as users and navigation is also deleted.
You cannot delete the mandatory groups, including Platform; Platform/guests; Platform/users.</para>
      </note>
    </section>

  </section>

  <section id="sect-User_Guide-User_Management-Manage_memberships">
    <title>Manage memberships</title>
    <para>
      The role of a user in a specific group is managed using the <emphasis role="bold">Membership Management</emphasis> tab.
    </para>
    <para>
      By default, three membership types are available:<emphasis>Manager</emphasis>,
      <emphasis>Member</emphasis>
      and<emphasis>Validator</emphasis>. By definition, <emphasis>Manager</emphasis> has got the highest rights in a group.
    </para>

    <mediaobject>
      <imageobject>
        <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" width="444"/>
      </imageobject>
    </mediaobject>

    <section id="sect-User_Guide-User_Management-Add_a_new_membership_type">
      <title>Add a new membership type</title>
      <procedure>
        <step>
          <para>
            In the
            <emphasis role="bold">Add/Edit Membership</emphasis>
            form, enter the values for the membership name field (required) and the description field (optional). Only
            letters, digits, dots, dashes and underscores are allowed for the membership name.
          </para>
        </step>
        <step>
          <para>
            Click the
            <emphasis role="bold">Save</emphasis> to accept adding a new membership, or <guibutton>Reset</guibutton> to clear entered values.
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Edit_a_membership_type">
      <title>Edit a membership type</title>
      <procedure>
        <step>
          <para>
            Click the edit icon corresponding to the membership type you want to edit in the Action column. Information about the selected membership type will be updated automatically in the <emphasis role="bold">Add/Edit Membership</emphasis> form.
          </para>
        </step>
        <step>
          <para>
            Make the desired changes to the description. You cannot change <guilabel>Membership
          </guilabel> name.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">Save</emphasis>
          </para>
        </step>
      </procedure>
    </section>

    <section id="sect-User_Guide-User_Management-Delete_a_membership_type">
      <title>Delete a membership type</title>
      <procedure>
        <step>
          <para>
            Click the trash icon in the Action column.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">OK</emphasis>
          </para>
        </step>
      </procedure>
    </section>
  </section>

</section>
