Author: smumford Date: 2012-10-09 23:54:14 -0400 (Tue, 09 Oct 2012) New Revision: 8862 Added: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/SP_Roles.xml epp/docs/branches/5.2/User_Guide/en-US/modules/portal/EPP_Roles.xml Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced.xml epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml Log: BZ#793802: Added draft of new content as supplied by Bruno Machado Added: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/SP_Roles.xml =================================================================== --- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/SP_Roles.xml (rev 0) +++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/SP_Roles.xml 2012-10-10 03:54:14 UTC (rev 8862) @@ -0,0 +1,199 @@ +<?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 "Site_Publisher_User_Guide.ent"> +%BOOK_ENTITIES; +]> + <section> + <title>Roles</title> + + <para> + Effective user management in JBoss Enterprise Portal Platform relies on an understanding of the rights and responsibilities of the various user roles available. + </para> + + <note> + <para> + The details below refer only to roles and memberships for the Site Publisher extension. For information regarding the roles in the core portal platform, refer to the the <citetitle>JBoss Enterprise Portal Platform User Guide</citetitle> available on <ulink type="http" url="https://access.redhat.com/knowledge/docs/"></ulink>;. + </para> + </note> + + <itemizedlist> + <title>Site Publisher Memberships</title> + + <listitem> + <para> + Author + </para> + </listitem> + + <listitem> + <para> + Editor + </para> + </listitem> + + <listitem> + <para> + Redactor + </para> + </listitem> + + <listitem> + <para> + Webdesigner + </para> + </listitem> + + <listitem> + <para> + Publisher + </para> + </listitem> + </itemizedlist> + + <table> + <title>Role Attributes of Example Users</title> + + <tgroup cols="2"> + <thead> + <row> + <entry> + User + </entry> + + <entry> + Roles + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + root + </entry> + <entry> + *:/platform/administrators,*:/platform/users,*:/platform/web-contributors + </entry> + </row> + + <row> + <entry> + john + </entry> + <entry> + *:/platform/administrators,*:/platform/web-contributors, *:/platform/users + </entry> + </row> + + <row> + <entry> + mary + </entry> + <entry> + member:/platform/users,editor:/platform/web-contributors,manager:/platform/web-contributors,publisher:/platform/web-contributors + </entry> + </row> + + <row> + <entry> + james + </entry> + <entry> + member:/platform/users,redactor:/platform/web-contributors,author:/platform/web-contributors + </entry> + </row> + + <row> + <entry> + demo + </entry> + <entry> + member:/platform/users + </entry> + </row> + </tbody> + </tgroup> + </table> + + <variablelist> + <title>Roles</title> + <varlistentry> + <term>*:/platform/administrators</term> + <listitem> + <para> + This core portal role extends edit permissions to Site Publisher components such as: Detail, Print Viewer, Group Navigation, Portal Navigation, Parameterized Content List Viewer, Category navigation, Content List Viewer, Single Content Viewer, Newsletter Viewer. Members also have root permissions for JCR repository configuration. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/users</term> + <listitem> + <para> + This core portal role is required for normal users to be able to log in. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>editor:/platform/web-contributors</term> + <listitem> + <para> + This role can edit pages in the <emphasis>acme</emphasis> portal: Overview, Search Result, Detail, Print Viewer, New Account, News, Events, Confirmation can edit Search Result in classic SP portal portal. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>manager:/platform/web-contributors</term> + <listitem> + <para> + This role can edit WCM Content Explorer, SiteExplorer Content Explorer, Editor, WCM Administration, Newsletter Manager Portlet, Form Generator Portlet and Workflow Controller. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>publisher:/platform/web-contributors</term> + <listitem> + <para> + This role can publish contents, for users to move content to <emphasis>staged</emphasis> and <emphasis>published</emphasis> states in the life cycle of SP and ecmdemo portal (lifecycle1 and lifecycle2). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>redactor:/platform/web-contributors</term> + <listitem> + <para> + This role is for users to access the newsletter management page. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>author:/platform/web-contributors</term> + <listitem> + <para> + This role can edit contents, for users to create content in <emphasis>draft</emphasis> and <emphasis>pending</emphasis> states in the life cycle of SP and ecmdemo portal (lifecycle1 and lifecycle2). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>editor:/platform/web-contributors</term> + <listitem> + <para> + This role is for users to get the edit mode drop-down in toolbar visible (<literal>WCMAdminToolbarPortlet</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>webdesigner:/platform/web-contributors</term> + <listitem> + <para> + This role has access to CSS and JavaScript templates. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <remark>DOCS NOTE: This last paragraph needs to be certified and technically verified.</remark> + </para> + <para> + It seems that it's possible to remove all memberships in Site Publisher. There is no validation checking for this action. Any membership dependencies may not be available if the parent membership is removed. Administrators will need to add required dependencies to some other membership or group to access or edit it. + </para> + </section> \ No newline at end of file Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced.xml =================================================================== --- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced.xml 2012-10-10 03:53:58 UTC (rev 8861) +++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced.xml 2012-10-10 03:54:14 UTC (rev 8862) @@ -6,6 +6,7 @@ ]> <chapter id="chap-User_Guide-Advanced_Actions"> <title>Advanced Actions</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Manage_Site_Resources.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Administration.xml"/> + <!-- DOCS NOTE: Bug 793802: Added Info about SP roles. Added in discrete file for relocation. --><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/SP_Roles.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Manage_Site_Resources.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Administration.xml"/> </chapter> Added: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/EPP_Roles.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/EPP_Roles.xml (rev 0) +++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/EPP_Roles.xml 2012-10-10 03:54:14 UTC (rev 8862) @@ -0,0 +1,205 @@ +<?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> + <title>Roles</title> + <para> + Effective user management in JBoss Enterprise Portal Platform relies on an understanding of the rights and responsibilities of the various user roles available. + </para> + + <note> + <para> + The details below refer only to roles and memberships for the core JBoss Enterprise Portal Platform product. For information regarding the roles in the Site Publisher extension, refer to the the <citetitle>JBoss Enterprise Portal Platform Site Publisher User Guide</citetitle> available on <ulink type="http" url="https://access.redhat.com/knowledge/docs/"></ulink>;. + </para> + </note> + + <itemizedlist> + <title>Core Portal Memberships</title> + <listitem> + <para> + Member + </para> + </listitem> + <listitem> + <para> + Manager + </para> + </listitem> + <listitem> + <para> + Validator + </para> + </listitem> + </itemizedlist> + + <table> + <title>Role Attributes of Example Users</title> + + <tgroup cols="2"> + <thead> + <row> + <entry> + User + </entry> + + <entry> + Roles + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + root + </entry> + <entry> + manager:/platform/administrators,member:/platform/users,member:/organization/management/executive-board + </entry> + </row> + + <row> + <entry> + john + </entry> + <entry> + member:/platform/administrators,member:/platform/users,manager:/organization/management/executive-board + </entry> + </row> + + <row> + <entry> + mary + </entry> + <entry> + member:/platform/users + </entry> + </row> + + <row> + <entry> + demo + </entry> + <entry> + member:/platform/guests,member:/platform/users + </entry> + </row> + </tbody> + </tgroup> + </table> + + <variablelist> + <title>Roles</title> + <varlistentry> + <term>manager:/platform/administrators</term> + <listitem> + <para> + This role is for users to have access and edit administrators pages. Examples are the New Account, Community Management, Registry, Page Management, New Staff, Organization Management and WSRP Admin pages. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/administrators</term> + <listitem> + <para> + This role is similar to the manager role above. The main difference is that it does not have access to the administrators pages, but can access and edit everything that falls under the <literal>*:/platform/administrators</literal> pages. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/administrators</term> + <listitem> + <para> + This role has edit permissions for everything. This includes; the Home Page, Group Navigation, Portal Navigation, Register and Site Map (in the <emphasis>classic</emphasis> portal). This membership also has permission to create and manage portals and has full permission with group navigation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/users</term> + <listitem> + <para> + This role allows standard users to log in. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/users</term> + <listitem> + <para> + This role has access to portal toolbars, dashboard, default gadgets (todo, rss, calculator and calendar) and basic portlets (sitemap and iframe). In general it can access but cannot edit these areas. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/organization/management/executive-board</term> + <listitem> + <para> + This role can edit New Staff and Organization Management pages. <remark>DOCS NOTE: I didn't see it in our EPP</remark> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>member:/platform/guests</term> + <listitem> + <para> + Members of this role can access the Register and Site Map pages. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/web-contributors</term> + <listitem> + <para> + This role can edit the Contact Us page, has taxonomies permission to read, add nodes, set and remove properties in <emphasis>acme</emphasis>, <emphasis>classic</emphasis> and <emphasis>events</emphasis> and is the newsletter marketing moderator, general moderator and subscription redactor. They have access to the <literal>ManageDrivePlugin</literal> for Collaboration and Events. This role also has access to toolbars. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>*:/platform/administrators</term> + <listitem> + <para> + This role grants access to the edit mode drop-down in toolbar visible (<literal>WCMAdminToolbarPortlet</literal>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>validator:*</term> + <listitem> + <para> + This role is not used. It can be removed if it is present in your instance. + </para> + </listitem> + </varlistentry> + </variablelist> + + <itemizedlist> + <title>Mandatory groups (groups that can not be deleted)</title> + <listitem> + <para> + /platform/administrators + </para> + </listitem> + <listitem> + <para> + /platform/users + </para> + </listitem> + <listitem> + <para> + /platform/guests + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <title>Mandatory membership types (Membership type that can not be deleted)</title> + <listitem> + <para> + member + </para> + </listitem> + </itemizedlist> +</section> Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml 2012-10-10 03:53:58 UTC (rev 8861) +++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml 2012-10-10 03:54:14 UTC (rev 8862) @@ -8,6 +8,8 @@ <para> Several tools are offered to assist Administrators manage users, groups and memberships easily and effectively. </para> + <!-- DOCS NOTE: Bug 793802: Added Info about EPP roles. Added in discrete file for relocation. --> + <xi:include href="EPP_Roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <section id="sect-User_Guide-User_Management-Manage_users"> <title>Manage users</title>