<?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-Manage_Permissions">
  <title>Manage Permissions</title>
  <para>
    Permissions play an important part in accessing and performing actions in the Portal. Depending on these permissions
    assigned by an administrator, users gain access to various components and actions such as edit portals, pages or
    portlets.
  </para>
  <para>To manage permissions, you need to learn about the concept mandatory. The mandatory is one of required
    conditions of system. GateIn provides two types of mandatory, including:
  </para>
  <itemizedlist>
    <listitem>
      <para>Mandatory membership type: member.</para>
    </listitem>
    <listitem>
      <para>Mandatory groups: /platform/administrators, /organization/management/executive-board, /platform/users,
        /platform/guests. These groups are set by default in eXo Platform.
      </para>
    </listitem>
  </itemizedlist>
  <para>Details:</para>
  <itemizedlist>
    <listitem>
      <para>The group
        <emphasis role="bold">/platform/administrators</emphasis>
        contains portal administrators with the highest rights related to the system, such as creating/editing/deleting
        new portals/pages.
      </para>
    </listitem>
    <listitem>
      <para>The group
        <emphasis role="bold">/organization/management/executive-board</emphasis>
        contains administrators having rights related to management of users and groups.
      </para>
    </listitem>
    <listitem>
      <para>The group
        <emphasis role="bold">/platform/users</emphasis>
        contains members of the portal. Any registered users automatically become members of this group.
      </para>
    </listitem>
  </itemizedlist>
  <para>Seeing a page in public means that you can access that page without signing in. To make a page accessible to the
    public, you have to follow these instructions:
  </para>
  <itemizedlist>
    <listitem>
      <para>The current portal in use must be in the public mode (everyone can access).</para>
    </listitem>
    <listitem>
      <para>The node containing the page that you want to see must belong to the public portal.</para>
    </listitem>
    <listitem>The page which is selected by the node above must be in the public mode.</listitem>
  </itemizedlist>
  <para>
    Details about permission types and levels can also be found in
    <xref linkend="sect-User_Guide-Permissions"/>
  </para>

  <section id="sect-User_Guide-Manage_Permission-Set_Portal_Permission">
    <title>Set Portal Permissions</title>
    <variablelist>
      <varlistentry>
        <term>
          <emphasis role="bold">New portals</emphasis>
        </term>
        <listitem>
          <para>
            Click
            <emphasis role="bold">Site</emphasis>
            in the Toolbar then click <emphasis role="bold">Add New Portal</emphasis>. Last select the
            <emphasis role="bold">Permission Setting</emphasis>
            tab.
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/AddPortal.png" format="PNG" align="center"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/AddPortal.png" format="PNG" align="center" contentwidth="120mm"/>
            </imageobject>
          </mediaobject>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <emphasis role="bold">Existing portals</emphasis>
        </term>
        <listitem>
          <para>
            On the Toolbar click
            <emphasis role="bold">Site</emphasis>
            then<emphasis role="bold">Edit Portal's Properties</emphasis>. Last select the
            <emphasis role="bold">Permission Setting</emphasis>
            tab.
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/EditActivePortals.png" format="PNG" align="center" scale="110"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/EditActivePortals.png" format="PNG" align="center" contentwidth="150mm"/>
            </imageobject>
          </mediaobject>
        </listitem>
        <listitem>
          <para>Or hover your cursor over
            <emphasis role="bold">Site</emphasis>
            on the Toolbar and then select your desired portal from the drop-down menu.
          </para>
          <itemizedlist>
            <listitem>
              <para>Select <guilabel>Site Editor</guilabel>, then
                <guilabel>Edit Layout</guilabel>
                on the Toobar.
              </para>
            </listitem>
            <listitem>
              <para>Click
                <guibutton>Site'Config</guibutton>
                the Edit Inline Composer, then select the
                <emphasis role="bold">Permission Setting</emphasis>
                tab.
              </para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
    </variablelist>


    <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portal">
      <title>Set Access permissions</title>
      <para>To access a portal, you must belong to one of the groups that have access permission to that portal.</para>
      <para>To set access permissions on a portal, you first need to go to Permission Setting as in the
        <xref linkend="sect-User_Guide-Manage_Permission-Set_Portal_Permission"/>
        and select the
        <emphasis role="bold">Access Permission Setting</emphasis>
        sub-tab.
      </para>
      <mediaobject>
        <imageobject>
          <imagedata fileref="images/PortalPermission.png" format="PNG" align="center" width="444"/>
        </imageobject>
      </mediaobject>

      <note>
        <title>Public access</title>
        <para>
          If you do not want your Portal to be publicly accessible, make sure the
          <emphasis role="bold">Make it public</emphasis>
          check box is clear.
        </para>
      </note>

      <para>
        If
        <emphasis role="bold">Make it public</emphasis>
        is clear, you need to add permissions by member group as follows.
      </para>

      <procedure>
        <step>
          <para>
            Click<emphasis role="bold">Add Permission</emphasis>. The
            <emphasis role="bold">Select Permission</emphasis>
            form will appear:
          </para>
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/PermissionSetting2.png" format="PNG" align="center" width="444"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/PermissionSetting2.png" format="PNG" align="center" contentwidth="150mm"/>
            </imageobject>
          </mediaobject>
        </step>
        <step>
          <para>
            Select the group that you want to add on the left pane and then select one membership type on the right
            pane. In the membership types list, the asterisk (*) indicates any membership types of the selected group
            are allowed.
          </para>
          <para>
            After selecting a membership type, the selected permission is displayed in the access permission list. You
            can only select one group with one membership type at a time. If you want to add more, click
            <emphasis role="bold">Add Permission</emphasis>
            and select again. Repeat the process for as many permission settings as you require.

          </para>
        </step>

      </procedure>

    </section>

    <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Portal">

      <title>Set Edit Permissions</title>
      <para>
        Only users members of the Editor group can edit that portal. Access rights can be given to several groups but
        edit rights can only be given to a group with a membership type. To assign an edit permission to a user, you
        must add him/her to the editor group of the respective portal.
      </para>
      <para>To assign the edit permission on a portal, do as follows:</para>


      <procedure>
        <step>
          <para>
            Click<emphasis role="bold">Edit Permission Setting</emphasis>:
          </para>
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/PermissionSetting1.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
        </step>

        <step>
          <para>
            Click
            <emphasis role="bold">Select Permission</emphasis>
            to choose a group.
          </para>
        </step>
        <step>
          <para>
            Select a group and a membership type from the left and right panes, respectively, of the
            <emphasis role="bold">Permission Selector</emphasis>
            window (select * if you want to assign all available membership types to the selected group).
          </para>
        </step>
        <step>
          <para>Click
            <guibutton>Save</guibutton>
            to accept, or
            <guibutton>Cancel</guibutton>
            to discard.
          </para>
        </step>

      </procedure>
    </section>

  </section>


  <!-- Set_Page_Permission -->


  <section id="sect-User_Guide-Manage_Permission-Set_Page_Permission">
    <title>Set Page Permission</title>
    <variablelist>
      <varlistentry>
        <term>
          <emphasis role="bold">User</emphasis>
        </term>
        <listitem>
          <para>
            If the Owner type of a page is "user", you don't have to set permissions, no one except the creator has got
            access and edit permissions.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <emphasis role="bold">Group</emphasis>
        </term>
        <listitem>
          <para>
            If the Owner type of a page is "group", initial permissions on page are:
          </para>
          <itemizedlist>
            <listitem>
              <para>
                Access permission: everyone in that group.
              </para>
            </listitem>
            <listitem>
              <para>
                Edit permission: the manager of that group.
              </para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <emphasis role="bold">Portal</emphasis>
        </term>
        <listitem>
          <para>
            If the Owner type of a page is portal, initial permissions are:
          </para>
          <itemizedlist>
            <listitem>
              <para>
                Access permission: users who can access that portal.
              </para>
            </listitem>
            <listitem>
              <para>
                Edit permission: users who can edit that portal.
              </para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
    </variablelist>

    <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Page">
      <title>Set Access Permission on a Page</title>

      <procedure>
        <step>
          <para>
            Open up the page you wish to configure. Select
            <emphasis role="bold">Site Editor</emphasis>
            on the Toolbar and select<emphasis role="bold">Edit Page</emphasis>.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">View Page Properties</emphasis>
            in the
            <emphasis role="bold">Page Editor</emphasis>
            applet.
          </para>
        </step>
        <step>
          <para>
            Click the
            <emphasis role="bold">Permission Setting</emphasis>
            tab.
          </para>
        </step>
      </procedure>

      <para>
        To be able to access a page users have to be in one of the groups that have access permission to that page.
        There may be several groups that have access rights to a page. A list of the permissions for that page will be
        shown (provided the
        <emphasis role="bold">Make it public</emphasis>
        check-box has not been used).
      </para>
      <procedure>
        <step>
          <para>
            Click
            <emphasis role="bold">Add Permission</emphasis>
          </para>
        </step>
        <step>
          <para>
            Select a group in the left pane then select a membership type.
          </para>
        </step>
        <step>
          <para>
            After selecting a membership type, the selected permission is displayed in the access right list.
            Note that you may associate group and membership only one at a time. To add more access permissions, click
            the
            <emphasis role="bold">Add Permission</emphasis>
            button and apply the same process again.
          </para>
        </step>
      </procedure>
      <para>
        If you want to allow any visitors to access the page tick the
        <emphasis role="bold">Make it public</emphasis>
        check-box. Any permission set for that page will be relaxed and the permissions list will disappear.
      </para>

    </section>

    <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Page">
      <title>Set Edit Permission on a Page</title>
      <para>
        Only users who are in the page's editor group can edit it. The access right can be set for several groups but
        the
        <emphasis>edit</emphasis>
        right only can be set for one group. To give a user the edit permission, you must add them to the editors group
        of that page.
      </para>
      <para>
        The Permission Setting tab is available in two different ways:
      </para>

      <para>
        Via Edit Page:
      </para>
      <procedure>
        <step>
          <para>
            Mouse over
            <emphasis role="bold">Site Editor</emphasis>
            on the Toolbar and select<emphasis role="bold">Edit Page</emphasis>.
          </para>
        </step>
        <step>
          <para>
            Click
            <emphasis role="bold">View Page Properties</emphasis>
            in the
            <emphasis role="bold">Page Editor</emphasis>
            applet.
          </para>
        </step>
        <step>
          <para>
            Click the
            <emphasis role="bold">Permission Setting</emphasis>
            tab then the
            <emphasis role="bold">Edit Permission Setting</emphasis>
            sub tab.
          </para>
        </step>
      </procedure>
      <para>
        Via Page Management:
      </para>
      <procedure>
        <step>
          <para>
            Mouse over
            <emphasis role="bold">Group</emphasis>
            on the Toolbar, highlight
            <emphasis role="bold">Administration</emphasis>
            and click <emphasis role="bold">Page Management</emphasis>.
          </para>
        </step>
        <step>
          <para>
            Locate the page you want to edit using the
            <emphasis role="bold">Page Id</emphasis>
            column then click the edit icon (next to the trash icon). You will be taken to the
            <emphasis role="bold">Page Editor</emphasis>
            applet.
          </para>
        </step>
        <step>
          <para>
            Click the
            <emphasis role="bold">Permission Setting</emphasis>
            tab then the
            <emphasis role="bold">Edit Permission Setting</emphasis>
            sub tab.
          </para>
        </step>
      </procedure>
      <para>
        You will see the
        <emphasis role="bold">Current Permission</emphasis>
        listed.
      </para>
      <procedure>
        <step>
          <para>
            Click the
            <emphasis role="bold">Select Permission</emphasis>
            button to set new or change another group.
          </para>
        </step>
        <step>
          <para>
            Select a group with a membership type (select * if you want all membership types in a selected group)
          </para>
        </step>
        <step>
          <para>
            After selecting a specific membership from the right, the selected information is displayed.
          </para>
        </step>
        <step>
          <para>
            Click the
            <emphasis role="bold">Save</emphasis>
          </para>
        </step>
      </procedure>
    </section>

  </section>

  <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Category">
    <title>Set Access Permission on a Category</title>
    <para>
      Setting access permission on a category allows to be able to list those categories when editing a page in order to
      add portlets or widgets.
    </para>
    <procedure>
      <step>
        <para>
          Mouse over
          <emphasis role="bold">Group</emphasis>
          on the Toolbar, highlight
          <emphasis role="bold">Administration</emphasis>
          then click <emphasis role="bold">Application Registry</emphasis>.
          <mediaobject>
            <imageobject>
              <imagedata fileref="images/EditCategoryPermissions.png" format="PNG" align="center" width="444"/>
            </imageobject>
          </mediaobject>
        </para>
      </step>
      <step>
        <para>
          In the list of categories available in the left pane, click the edit icon, then choose the
          <emphasis role="bold">Permission Setting</emphasis>
          tab.
        </para>
      </step>
      <step>
        <para>
          To set permissions for a category:
        </para>
        <procedure>
          <step>
            <para>
              Click the
              <emphasis role="bold">Add Permission</emphasis>
              button to add access permissions to more groups .
            </para>
          </step>
          <step>
            <para>
              Or select the
              <emphasis role="bold">Make it public</emphasis>
              check box to allow everyone to access.
            </para>
          </step>
        </procedure>
      </step>
    </procedure>
  </section>

  <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portlet">
    <title>Set Access Permission on a Portlet</title>
    <procedure>
      <step>
        <para>
          Select
          <emphasis role="bold">Group</emphasis>
          on the Toolbar. Highlight the
          <emphasis role="bold">Administration</emphasis>
          entry and click <emphasis role="bold">Application Registry</emphasis>.
          <mediaobject>
            <imageobject role="html">
              <imagedata fileref="images/Application1.png" format="PNG" align="center" width="444"/>
            </imageobject>
            <imageobject role="fo">
              <imagedata fileref="images/Application1.png" format="PNG" align="center" contentwidth="150mm"/>
            </imageobject>
          </mediaobject>
        </para>
      </step>
      <step>
        <para>
          Select a category on the left pane that includes the portlet you want to set rights for. Then all portlets of
          the selected category are listed immediately and detail information of each portlet is displayed on the right
          pane.
        </para>
      </step>
      <step>
        <para>
          To set permissions for a portlet:
        </para>
        <procedure>
          <step>
            <para>
              Click the
              <emphasis role="bold">Add Permission</emphasis>
              button to add access permissions to more groups .
            </para>
          </step>
          <step>
            <para>
              Or select the
              <emphasis role="bold">Make it public</emphasis>
              check box to allow everyone to access.
            </para>
          </step>
        </procedure>
      </step>
    </procedure>
  </section>

</section>


