gatein SVN: r8229 - components/wsrp/branches/2.1.x/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors.
by do-not-reply＠jboss.org
Author: chris.laprun(a)jboss.com
Date: 2011-12-09 05:47:19 -0500 (Fri, 09 Dec 2011)
New Revision: 8229
Modified:
components/wsrp/branches/2.1.x/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java
Log:
- GTNWSRP-274: Default implementation should return -1 instead of throwing an exception.
Modified: components/wsrp/branches/2.1.x/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java
===================================================================
--- components/wsrp/branches/2.1.x/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java 2011-12-09 10:27:14 UTC (rev 8228)
+++ components/wsrp/branches/2.1.x/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java 2011-12-09 10:47:19 UTC (rev 8229)
@@ -65,7 +65,7 @@
public int getContentLength()
{
- throw new UnsupportedOperationException("Not currently supported");
+ return -1;
}
public BufferedReader getReader() throws IOException
@@ -130,6 +130,12 @@
{
return contentType;
}
+
+ @Override
+ public int getContentLength()
+ {
+ return 0;
+ }
}
static class WSRPMultiRequestContext extends WSRPRequestContext
13 years
- 1
- 0
gatein SVN: r8228 - components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors.
by do-not-reply＠jboss.org
Author: chris.laprun(a)jboss.com
Date: 2011-12-09 05:27:14 -0500 (Fri, 09 Dec 2011)
New Revision: 8228
Modified:
components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java
Log:
- GTNWSRP-274: Default implementation should return -1 instead of throwing an exception.
Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java 2011-12-09 04:04:56 UTC (rev 8227)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/wsrp/producer/handlers/processors/WSRPRequestContext.java 2011-12-09 10:27:14 UTC (rev 8228)
@@ -65,7 +65,7 @@
public int getContentLength()
{
- throw new UnsupportedOperationException("Not currently supported");
+ return -1;
}
public BufferedReader getReader() throws IOException
@@ -130,6 +130,12 @@
{
return contentType;
}
+
+ @Override
+ public int getContentLength()
+ {
+ return 0; // todo: is it really the case or should it be -1?
+ }
}
static class WSRPMultiRequestContext extends WSRPRequestContext
13 years
- 1
- 0
gatein SVN: r8227 - epp/docs/branches/5.2/User_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 23:04:56 -0500 (Thu, 08 Dec 2011)
New Revision: 8227
Modified:
epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
Log:
Incrementing for stage
Modified: epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2011-12-09 03:48:33 UTC (rev 8226)
+++ epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2011-12-09 04:04:56 UTC (rev 8227)
@@ -7,7 +7,7 @@
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
<edition>5.2.0</edition>
- <pubsnumber>9</pubsnumber>
+ <pubsnumber>10</pubsnumber>
<abstract>
<para>
This document provides an easy to follow guide to the functions and
Modified: epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2011-12-09 03:48:33 UTC (rev 8226)
+++ epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2011-12-09 04:04:56 UTC (rev 8227)
@@ -8,7 +8,7 @@
<simpara>
<revhistory>
<revision>
- <revnumber>5.2.0-9</revnumber>
+ <revnumber>5.2.0-10</revnumber>
<date>Fri Dec 9 2011</date>
<author>
<firstname>Scott</firstname>
13 years
- 1
- 0
gatein SVN: r8226 - epp/docs/branches/5.2/User_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 22:48:33 -0500 (Thu, 08 Dec 2011)
New Revision: 8226
Modified:
epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
Log:
Incremented for staging
Modified: epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2011-12-09 03:47:48 UTC (rev 8225)
+++ epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2011-12-09 03:48:33 UTC (rev 8226)
@@ -7,7 +7,7 @@
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
<edition>5.2.0</edition>
- <pubsnumber>8</pubsnumber>
+ <pubsnumber>9</pubsnumber>
<abstract>
<para>
This document provides an easy to follow guide to the functions and
Modified: epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2011-12-09 03:47:48 UTC (rev 8225)
+++ epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2011-12-09 03:48:33 UTC (rev 8226)
@@ -8,7 +8,7 @@
<simpara>
<revhistory>
<revision>
- <revnumber>5.2.0-8</revnumber>
+ <revnumber>5.2.0-9</revnumber>
<date>Fri Dec 9 2011</date>
<author>
<firstname>Scott</firstname>
13 years
- 1
- 0
gatein SVN: r8225 - in epp/docs/branches/5.2/User_Guide/en-US: modules and 1 other directory.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 22:47:48 -0500 (Thu, 08 Dec 2011)
New Revision: 8225
Modified:
epp/docs/branches/5.2/User_Guide/en-US/images/EditLayout3.png
epp/docs/branches/5.2/User_Guide/en-US/modules/Supported_Browsers.xml
Log:
JBEPP-1431: QE edits
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/EditLayout3.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/Supported_Browsers.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/modules/Supported_Browsers.xml 2011-12-09 03:15:22 UTC (rev 8224)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/Supported_Browsers.xml 2011-12-09 03:47:48 UTC (rev 8225)
@@ -22,7 +22,7 @@
</listitem>
<listitem>
<para>
- <ulink type="http" url="http://windows.microsoft.com/en-AU/internet-explorer/downloads/ie">Internet Explorer</ulink> (versions 7 and 9).
+ <ulink type="http" url="http://windows.microsoft.com/en-AU/internet-explorer/downloads/ie">Internet Explorer</ulink> (versions 7 to 9).
</para>
</listitem>
<listitem>
13 years
- 1
- 0
gatein SVN: r8224 - in epp/docs/branches/5.2/User_Guide/en-US: modules/portal and 1 other directory.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 22:15:22 -0500 (Thu, 08 Dec 2011)
New Revision: 8224
Modified:
epp/docs/branches/5.2/User_Guide/en-US/images/DragPage1.png
epp/docs/branches/5.2/User_Guide/en-US/images/DragPage3.png
epp/docs/branches/5.2/User_Guide/en-US/images/ManagePage.png
epp/docs/branches/5.2/User_Guide/en-US/images/PageNodeSetting.png
epp/docs/branches/5.2/User_Guide/en-US/images/PageSetting1.png
epp/docs/branches/5.2/User_Guide/en-US/images/Pagewizard1.png
epp/docs/branches/5.2/User_Guide/en-US/images/PermissionSetting2.png
epp/docs/branches/5.2/User_Guide/en-US/images/Wizard1.png
epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Navigation_Nodes.xml
epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Pages.xml
epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Permission.xml
epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml
epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml
Log:
JBEPP-1431: QE edits
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/DragPage1.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/DragPage3.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/ManagePage.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/PageNodeSetting.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/PageSetting1.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/Pagewizard1.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/PermissionSetting2.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/images/Wizard1.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Navigation_Nodes.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Navigation_Nodes.xml 2011-12-09 00:58:12 UTC (rev 8223)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Navigation_Nodes.xml 2011-12-09 03:15:22 UTC (rev 8224)
@@ -257,7 +257,7 @@
</section>
<section id="sect-User_Guide-Manage_Navigation_Nodes-Edit_a_node">
- <title>Edit a node</title>
+ <title><remark>Edit a node</remark></title>
<procedure>
<step>
<para>
@@ -287,6 +287,16 @@
In the <emphasis role="bold">Page Node Setting</emphasis> tab you can change the value of these fields:
</para>
<itemizedlist>
+ <listitem>
+ <para>
+ Extended label node
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Language
+ </para>
+ </listitem>
<listitem>
<para>Label</para>
</listitem>
@@ -467,7 +477,7 @@
</para>
<mediaobject>
<imageobject>
- <imagedata fileref="images/http.png" format="PNG" align="center" />
+ <imagedata fileref="images/httpNode.png" format="PNG" align="center" />
</imageobject>
</mediaobject>
</step>
Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Pages.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Pages.xml 2011-12-09 00:58:12 UTC (rev 8223)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Pages.xml 2011-12-09 03:15:22 UTC (rev 8224)
@@ -9,7 +9,7 @@
<title>Adding a new Page</title>
<section id="sect-User_Guide-Page_Creation_Wizard">
- <title>Adding a new Page using Page Creation Wizard</title>
+ <title><remark>Adding a new Page using Page Creation Wizard</remark></title>
<para>
A page creation wizard is available to administrators in order to create and publish portal pages quickly and easily.
</para>
@@ -68,6 +68,22 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>Extended label mode</term>
+ <listitem>
+ <para>
+ This is a new feature which allows Administrators to add labels to pages in multiple supported languages. When the language of the site is changed, the pages will display the appropriate localized label.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Language</term>
+ <listitem>
+ <para>
+ Set the language for the page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><emphasis role="bold">Display Name</emphasis></term>
<listitem>
<para>
@@ -189,6 +205,14 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>View Page properties</term>
+ <listitem>
+ <para>
+ Allows reviewing or changing various page settings (<guilabel>title</guilabel>, <guilabel>Page ID</guilabel> and more) and/or page permissions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>Switch View mode</term>
<listitem>
<para>
@@ -216,7 +240,7 @@
<section id="sect-User_Guide-Manage_Pages-Add_a_new_Page_in_the_Page_List">
- <title>Adding a new Page using Page Management</title>
+ <title><remark>Adding a new Page using Page Management</remark></title>
<procedure>
<step>
<para>
@@ -250,9 +274,6 @@
<term><emphasis role="bold">Owner type</emphasis></term>
<listitem>
<para>
- If the page <emphasis role="bold">Owner type</emphasis> is set to <emphasis>user</emphasis>, only the specified user (creator) can access and edit the page.
- </para>
- <para>
If the page <emphasis role="bold">Owner type</emphasis> is set to <emphasis>portal</emphasis> the page is created with shared ownership portal. Therefore users who have <emphasis>edit</emphasis> permissions on the <emphasis>portal</emphasis> level can edit this page type.
</para>
<para>
@@ -283,7 +304,7 @@
<term><emphasis role="bold">Page Name</emphasis></term>
<listitem>
<para>
- The name of the page. This is a required field and must be unique. Only alphabetical, numerical and underscore characters are allowed to be used for this field and the name must be at least 3 and no more than 30 characters in length.
+ The name of the page. This is a required field and must be unique. Only alphabetical, numerical, dash and underscore characters are allowed to be used for this field and the name must be at least 3 and no more than 30 characters in length.
</para>
</listitem>
</varlistentry>
@@ -291,7 +312,7 @@
<term><emphasis role="bold">Page title</emphasis></term>
<listitem>
<para>
- The title of the page. This is an optional field. If you choose to add a title to the page it must be at least 3 and no more than 30 characters in length.
+ The title of the page. This is an optional field. If you choose to add a title to the page it must be at least 3 and no more than 120 characters in length.
</para>
</listitem>
</varlistentry>
@@ -365,7 +386,7 @@
</section>
<section id="sect-User_Guide-Manage_Pages-Edit_a_Page">
- <title>Edit a Page</title>
+ <title><remark>Edit a Page</remark></title>
<procedure>
<step>
<para>
@@ -377,7 +398,7 @@
Click the edit icon on the row of page you want to edit in the existing page list.
</para>
<para>
- Click the edit icon to show a form to edit page properties.
+ Click View Page properties icon to show a form to edit page properties.
</para>
</step>
<step>
@@ -389,9 +410,6 @@
<term>Permission Setting</term>
<listitem>
<para>
- This form is supported for pages with <emphasis>group</emphasis> or <emphasis>portal</emphasis> ownership types. Because a user page is private, no user, other than the creator, can access or edit it.
- </para>
- <para>
Permission on each page is set in two levels: <emphasis role="bold">Access right</emphasis> and <emphasis role="bold">Edit right</emphasis>.
</para>
</listitem>
@@ -400,10 +418,10 @@
<term>Access right</term>
<listitem>
<para>
- The page <emphasis role="bold">Access right</emphasis> can be set to specific user groups or set to everyone (this includes unregistered users).
+ <emphasis role="bold">Access right</emphasis> can be set to specific user groups or set to everyone (this includes unregistered users).
</para>
<para>
- Current access permissions on page are listed and you can remove permissions (by clicking the delete icon) or add further permission (by click the <emphasis role="bold">Add Permission</emphasis> button).
+ Current access permissions on page are listed in <guilabel>Access Permission Setting</guilabel> tab and you can remove permissions (by clicking the <guilabel>delete</guilabel> icon) or add further permission (by clicking the <guilabel>Add Permission</guilabel> button).
</para>
<para>
Populating the <emphasis role="bold">Make it public</emphasis> check box will allow all users (registered or unregistered) to access the page.
@@ -417,15 +435,15 @@
The <emphasis role="bold">Edit right</emphasis> allows users to change information on a page. <emphasis role="bold">Edit right</emphasis> only is set for a group of users.
</para>
<para>
- <emphasis role="bold">Edit right</emphasis> can be set for one specific membership type within a particular group (<emphasis role="bold">*</emphasis> allows every membership type in a group). If you want to re-assign this right to another group, click <emphasis role="bold">Select Permission</emphasis> to choose another one.
+ <emphasis role="bold">Edit right</emphasis> can be set for one specific membership type within a particular group (<emphasis role="bold">*</emphasis> allows every membership type in a group). If you want to re-assign this right to another group, click <guilabel>Select Permission</guilabel> in <guilabel>Edit Permission Setting</guilabel> tab to choose another one.
</para>
</listitem>
</varlistentry>
</variablelist>
</step>
- <step>
+ <!--<step>
<variablelist>
-<!-- <varlistentry>
+ <varlistentry>
<term>Editing page container layout</term>
<listitem>
<para>
@@ -450,7 +468,7 @@
If you want to change the current layout, select a layout type from the list on the left pane, then drag it into the right pane. The new portlet will be added and displayed in the right pane. You can change the position of the current portlet by dragging it to the place you want on the right pane, or remove it completely by clicking the delete icon.
</para>
</listitem>
- </varlistentry> -->
+ </varlistentry>
<varlistentry>
<term>Edit the Layout</term>
<listitem>
@@ -459,8 +477,8 @@
</para>
</listitem>
</varlistentry>
- </variablelist>
- </step>
+ </variablelist>
+ </step> -->
</procedure>
</section>
Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Permission.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Permission.xml 2011-12-09 00:58:12 UTC (rev 8223)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Permission.xml 2011-12-09 03:15:22 UTC (rev 8224)
@@ -19,16 +19,8 @@
<term><emphasis role="bold">New portals</emphasis></term>
<listitem>
<para>
- Click on <emphasis role="bold">Site</emphasis> in the Toolbar then click on <emphasis role="bold">Add New Portal</emphasis>. Last select the <emphasis role="bold">Permission Setting</emphasis> tab.
+ Click on <menuchoice><guimenu>Site</guimenu></menuchoice> on the <guilabel>Toolbar</guilabel> , then click on <menuchoice><guimenuitem>Add New Portal</guimenuitem><guimenuitem>Permission Setting</guimenuitem></menuchoice>
</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>
@@ -38,14 +30,6 @@
<para>
On the Toolbar click <emphasis role="bold">Site</emphasis> then <emphasis role="bold">Edit Portal's Properties</emphasis>. Then select the <emphasis role="bold">Permission Setting</emphasis> tab.
</para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/PortalProperties.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/PortalProperties.png" format="PNG" align="center" contentwidth="130mm" />
- </imageobject>
- </mediaobject>
</listitem>
</varlistentry>
</variablelist>
@@ -89,7 +73,7 @@
</step>
<step>
<para>
- Make the appropriate selections from the <emphasis>group</emphasis> and <emphasis>membership</emphasis> options presented in the <emphasis role="bold">Permission Selector</emphasis> dialogue box.
+ Make the appropriate selections from the group and membership options presented in the <guilabel>Select Permission</guilabel> dialogue box.
</para>
</step>
<step>
@@ -151,14 +135,6 @@
<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>
@@ -331,6 +307,11 @@
<para>
Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar, highlight <emphasis role="bold">Administration</emphasis> then click on <emphasis role="bold">Application Registry</emphasis>.
</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>
<mediaobject>
<imageobject role="html">
<imagedata fileref="images/EditCategoryPermissions.png" format="PNG" align="center" scale="100" />
@@ -342,11 +323,6 @@
</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>
Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml 2011-12-09 00:58:12 UTC (rev 8223)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml 2011-12-09 03:15:22 UTC (rev 8224)
@@ -308,16 +308,23 @@
</section>
<section id="sect-User_Guide-Change_Portal_Skins">
- <title>Change Portal Skins</title>
+ <title><remark>Change Portal Skins</remark></title>
<para>
Skins are graphic styles used to provide an attractive user interface. Each skin has its own characteristics with different backgrounds, icons, and other visual elements.
</para>
<para>
- Skins can be changed temporarily (and are reset at log-out) or permanently.
+ There are two ways to change the portal skin, each offering differing effects on the user experience.
</para>
+
+ <para>
+ When you set skin using <emphasis role="bold">method one</emphasis> change is applied to this portal, and every user that accesses this portal will see it in the chosen skin.
+ </para>
+ <para>
+ When you change skin using <emphasis role="bold">method two</emphasis>, the skin is set for the logged in user and all portals within the domain will be shown with the chosen skin.
+ </para>
<variablelist>
<varlistentry>
- <term><emphasis role="bold">Change the skin temporarily</emphasis></term>
+ <term><emphasis role="bold">Method One</emphasis></term>
<listitem>
<procedure>
<step>
@@ -355,7 +362,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis role="bold">Change the skin permanently</emphasis></term>
+ <term><emphasis role="bold">Method Two</emphasis></term>
<listitem>
<procedure>
<step>
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 2011-12-09 00:58:12 UTC (rev 8223)
+++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/User_Management.xml 2011-12-09 03:15:22 UTC (rev 8224)
@@ -4,497 +4,502 @@
%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>
+ <title>Manage Users and Groups</title>
+ <para>
+ Several tools are offered to assist Administrators manage users, groups and memberships easily and effectively.
+ </para>
- <section id="sect-User_Guide-User_Management-Manage_users">
- <title>Manage users</title>
- <para>
- Mouse over <emphasis role="bold">Group</emphasis> in the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/UserManage.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/UserManage.png" format="PNG" align="center" contentwidth="150mm" />
- </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.
- </para>
+ <section id="sect-User_Guide-User_Management-Manage_users">
+ <title>Manage users</title>
+ <para>
+ Mouse over <emphasis role="bold">Group</emphasis> in the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/UserManage.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/UserManage.png" format="PNG" align="center" contentwidth="150mm" />
+ </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.
+ </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 on <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="100" />
- </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 Setting</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-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 on <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="100" />
+ </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 Setting</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 role="html">
- <imagedata fileref="images/SearchUser.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/SearchUser.png" format="PNG" align="center" contentwidth="150mm" />
- </imageobject>
- </mediaobject>
- </step>
- <step>
- <para>
- Type in a partial/full string which identifies the user record being searched. The <emphasis role="bold">*</emphasis> character can be used as a wild-card.
- </para>
- </step>
- <step>
- <para>
- Click the magnifying glass icon to begin the search.
- </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>
+ Mouse over <guilabel>Group</guilabel> in the Toolbar. Highlight <guilabel>Organization</guilabel> and select <guilabel>Users and Groups Management</guilabel>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Select the information type (name, email, etc) to search against
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/SearchUser.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/SearchUser.png" format="PNG" align="center" contentwidth="150mm" />
+ </imageobject>
+ </mediaobject>
+ </step>
+ <step>
+ <para>
+ Type in a partial/full string which identifies the user record being searched. The <emphasis role="bold">*</emphasis> character can be used as a wild-card.
+ </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 a user</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 role="html">
- <imagedata fileref="images/Demo1.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/Demo1.png" format="PNG" align="center" contentwidth="150mm" />
- </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 role="html">
- <imagedata fileref="images/Demo3.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/Demo3.png" format="PNG" align="center" contentwidth="150mm" />
- </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-Edit_a_user">
+ <title>Edit a user</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 role="html">
+ <imagedata fileref="images/Demo1.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/Demo1.png" format="PNG" align="center" contentwidth="150mm" />
+ </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 between 6 and 30 characters.
+ </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 role="html">
+ <imagedata fileref="images/Demo3.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/Demo3.png" format="PNG" align="center" contentwidth="150mm" />
+ </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>
- <para>
- Click the trash icon in the Action column
- </para>
- </step>
- <step>
- <para>
- Click <emphasis role="bold">OK</emphasis> to confirm.
- </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>
+ <para>
+ Click the trash icon in the Action column
+ </para>
+ </step>
+ <step>
+ <para>
+ Click <emphasis role="bold">OK</emphasis> to confirm.
+ </para>
+ </step>
+ </procedure>
+ </section>
- </section>
+ </section>
- <section id="sect-User_Guide-User_Management-Manage_groups">
- <title>Manage groups</title>
- <para>
- Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>
- </para>
- <para>Select the tab <emphasis role="bold">Group Management</emphasis></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 role="html">
- <imagedata fileref="images/GroupManage.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/GroupManage.png" format="PNG" align="center" contentwidth="150mm" />
- </imageobject>
- </mediaobject>
- <section id="sect-User_Guide-User_Management-Add_a_new_group">
- <title>Add a New Group</title>
- <procedure>
- <step>
- <para>
- First choose where in the existing group structure you want the new group to be created. You may navigate up the tree by clicking on the green vertical little arrow at the top of the tree. The current path is displayed in the path 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 <emphasis role="bold">Add New Group</emphasis>.
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/AddGroup.png" format="PNG" align="center" scale="100" />
- </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>
- </section>
+ <section id="sect-User_Guide-User_Management-Manage_groups">
+ <title>Manage groups</title>
+ <para>
+ Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>
+ </para>
+ <para>Select the tab <emphasis role="bold">Group Management</emphasis></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 role="html">
+ <imagedata fileref="images/GroupManage.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/GroupManage.png" format="PNG" align="center" contentwidth="150mm" />
+ </imageobject>
+ </mediaobject>
+ <section id="sect-User_Guide-User_Management-Add_a_new_group">
+ <title>Add a New Group</title>
+ <procedure>
+ <step>
+ <para>
+ First choose where in the existing group structure you want the new group to be created. You may navigate up the tree by clicking on the green vertical little arrow at the top of the tree. The current path is displayed in the path 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 <emphasis role="bold">Add New Group</emphasis>.
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/AddGroup.png" format="PNG" align="center" scale="100" />
+ </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 0 to 255 characters is allowed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </step>
+ <step>
+ <para>
+ Fill in the required fields. Only letters, numbers, dash and underscore characters are allowed for the <guilabel>Group Name</guilabel> field. The name must be unique within the portal.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click <emphasis role="bold">Save</emphasis>
+ </para>
+ </step>
+ </procedure>
+ </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 on the label
- </para>
- </step>
- <step>
- <para>
- Click the edit icon to display the <emphasis role="bold">Edit Selected 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>
- </para>
- </step>
- </procedure>
- </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 on the label
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the edit icon to display the <emphasis role="bold">Edit Selected 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>
+ </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 on its label. Existing group memberships are listed on the right hand side along with the <emphasis role="bold">Add Member</emphasis> window.
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/AddMember1.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/AddMember1.png" format="PNG" align="center" contentwidth="150mm" />
- </imageobject>
- </mediaobject>
- </step>
- <step>
- <para>
- Click on 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 on the refresh icon to get the latest list.
- </para>
- </step>
- <step>
- <para>
- Click <emphasis role="bold">Save</emphasis>
- </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 on its label. Existing group memberships are listed on the right hand side along with the <emphasis role="bold">Add Member</emphasis> window.
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/AddMember1.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/AddMember1.png" format="PNG" align="center" contentwidth="150mm" />
+ </imageobject>
+ </mediaobject>
+ </step>
+ <step>
+ <para>
+ Click on 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 on the refresh icon to get the latest list.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click <emphasis role="bold">Save</emphasis>
+ </para>
+ </step>
+ </procedure>
+ </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 in the Action column
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/EditMember1.png" format="PNG" align="center" scale="100"/>
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/EditMember1.png" format="PNG" align="center" contentwidth="90mm"/>
- </imageobject>
- </mediaobject>
- </step>
- <step>
- <para>
- Select another membership.
- </para>
- </step>
- <step>
- <para>
- Click <emphasis role="bold">Save</emphasis>.
- </para>
- </step>
- </procedure>
- </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 in the Action column
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/EditMember1.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/EditMember1.png" format="PNG" align="center" contentwidth="90mm"/>
+ </imageobject>
+ </mediaobject>
+ </step>
+ <step>
+ <para>
+ Select another membership.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click <emphasis role="bold">Save</emphasis>.
+ </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.
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" scale="100" />
- </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>
- </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.
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" scale="100" />
+ </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>
+ </section>
- </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 memberships.
- </para>
- <para>
- By default three membership types are available: <emphasis>Manager</emphasis>, <emphasis>Member</emphasis> and <emphasis>Validator</emphasis>. By definition, Manager has got the highest rights in a group.
- </para>
- <para>
- Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>. Select the <emphasis role="bold">Membership Management</emphasis> tab.
- </para>
- <para>
- This tab remembers the last action taken by a user in this page. Clicking <emphasis role="bold">Reset</emphasis> will clear any legacy details.
- </para>
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" scale="100" />
- </imageobject>
- <imageobject role="fo">
- <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" contentwidth="110mm"/>
- </imageobject>
- </mediaobject>
+ <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 memberships.
+ </para>
+ <para>
+ By default three membership types are available: <emphasis>Manager</emphasis>, <emphasis>Member</emphasis> and <emphasis>Validator</emphasis>. By definition, Manager has got the highest rights in a group.
+ </para>
+ <para>
+ Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>. Select the <emphasis role="bold">Membership Management</emphasis> tab.
+ </para>
+ <para>
+ This tab remembers the last action taken by a user in this page. Clicking <emphasis role="bold">Reset</emphasis> will clear any legacy details.
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" contentwidth="110mm"/>
+ </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>
- </para>
- </step>
- </procedure>
- </section>
+ <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 and it must be between 3 and 30 characters.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <emphasis role="bold">Save</emphasis>
+ </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 in the Action column.
- </para>
- </step>
- <step>
- <para>
- Make the desired changes to the description.
- </para>
- </step>
- <step>
- <para>
- Click <emphasis role="bold">Save</emphasis>
- </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 in the Action column.
+ </para>
+ </step>
+ <step>
+ <para>
+ Make the desired changes to the description.
+ </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 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>
13 years
- 1
- 0
gatein SVN: r8223 - epp/docs/branches/5.2/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 19:58:12 -0500 (Thu, 08 Dec 2011)
New Revision: 8223
Modified:
epp/docs/branches/5.2/Developer_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/Developer_Guide/en-US/Revision_History.xml
Log:
Increment for staging
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/Book_Info.xml 2011-12-09 00:56:30 UTC (rev 8222)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/Book_Info.xml 2011-12-09 00:58:12 UTC (rev 8223)
@@ -6,7 +6,7 @@
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
<edition>5.2.0</edition>
- <pubsnumber>5</pubsnumber>
+ <pubsnumber>6</pubsnumber>
<abstract>
<para>
This guide is intended to assist developers working with JBoss Enterprise Portal Platform. It assumes a high level of technical knowledge.
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/Revision_History.xml 2011-12-09 00:56:30 UTC (rev 8222)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/Revision_History.xml 2011-12-09 00:58:12 UTC (rev 8223)
@@ -6,6 +6,20 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>5.2.0-6</revnumber>
+ <date>Fri Dec 9 2011</date>
+ <author>
+ <firstname>Scott</firstname>
+ <surname>Mumford</surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>QE edits.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>5.2.0-5</revnumber>
<date>Friday Nov 25 2011</date>
<author>
13 years
- 1
- 0
gatein SVN: r8222 - epp/docs/branches/5.2/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 19:56:30 -0500 (Thu, 08 Dec 2011)
New Revision: 8222
Modified:
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
Log:
JBEPP-1431: Adjust image sizings in XML
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-09 00:52:54 UTC (rev 8221)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-09 00:56:30 UTC (rev 8222)
@@ -140,10 +140,6 @@
<imageobject role="html">
<imagedata fileref="images/7372876/simpleinfra.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372876/simpleinfra.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
@@ -158,10 +154,6 @@
<imageobject role="html">
<imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
</section>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2011-12-09 00:52:54 UTC (rev 8221)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2011-12-09 00:56:30 UTC (rev 8222)
@@ -99,15 +99,10 @@
<figure>
<title>Example</title>
-
<mediaobject>
<imageobject role="html">
<imagedata fileref="images/7372952/diagram-standalone-index.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372952/diagram-standalone-index.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
</section>
@@ -134,10 +129,6 @@
<imageobject role="html">
<imagedata fileref="images/7372952/diagram-local-index.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372952/diagram-local-index.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
</section>
@@ -186,10 +177,6 @@
<imageobject role="html">
<imagedata fileref="images/7372952/diagram-shared-index.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372952/diagram-shared-index.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
</section>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2011-12-09 00:52:54 UTC (rev 8221)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2011-12-09 00:56:30 UTC (rev 8222)
@@ -65,12 +65,8 @@
<mediaobject>
<imageobject role="html">
- <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" scale="10"/>
+ <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" scale="100"/>
</imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" width="150mm"/>
- </imageobject>
</mediaobject>
</figure>
13 years
- 1
- 0
gatein SVN: r8221 - in epp/docs/branches/5.2/Developer_Guide/en-US: images/7372876 and 1 other directory.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 19:52:54 -0500 (Thu, 08 Dec 2011)
New Revision: 8221
Modified:
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
epp/docs/branches/5.2/Developer_Guide/en-US/images/7372876/complexinfra.png
Log:
JBEPP-1431: Ajust image size
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-09 00:50:40 UTC (rev 8220)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-09 00:52:54 UTC (rev 8221)
@@ -156,7 +156,7 @@
<mediaobject>
<imageobject role="html">
- <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" scale="150"/>
+ <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" scale="100"/>
</imageobject>
<imageobject role="fo">
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/images/7372876/complexinfra.png
===================================================================
(Binary files differ)
13 years
- 1
- 0
gatein SVN: r8220 - epp/docs/branches/5.2/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2011-12-08 19:50:40 -0500 (Thu, 08 Dec 2011)
New Revision: 8220
Modified:
epp/docs/branches/5.2/Developer_Guide/en-US/Author_Group.xml
epp/docs/branches/5.2/Developer_Guide/en-US/Developer_Guide.xml
epp/docs/branches/5.2/Developer_Guide/en-US/Preface.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
epp/docs/branches/5.2/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
JBEPP-1431: Further QE edits
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/Author_Group.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/Author_Group.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/Author_Group.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,25 +1,59 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<authorgroup>
-
- <author>
- <firstname>Vlastimil</firstname>
- <surname>Eliáš</surname>
- <email>velias(a)redhat.com</email>
- </author>
- <author>
- <firstname>Thomas</firstname>
- <surname>Heute</surname>
- <email>theute(a)redhat.com</email>
- </author>
- <author>
- <firstname>Prabhat</firstname>
- <surname>Jha</surname>
- <email>prabhat.jha(a)jboss.com</email>
- </author>
- <author>
- <firstname>Scott</firstname>
- <surname>Mumford</surname>
- <email>smumford(a)redhat.com</email>
- </author>
-</authorgroup>
+ <authorgroup>
+ <author>
+ <firstname>
+ Vlastimil
+ </firstname>
+
+ <surname>
+ Eliáš
+ </surname>
+
+ <email>
+ velias(a)redhat.com
+ </email>
+ </author>
+
+ <author>
+ <firstname>
+ Thomas
+ </firstname>
+
+ <surname>
+ Heute
+ </surname>
+
+ <email>
+ theute(a)redhat.com
+ </email>
+ </author>
+
+ <author>
+ <firstname>
+ Prabhat
+ </firstname>
+
+ <surname>
+ Jha
+ </surname>
+
+ <email>
+ prabhat.jha(a)jboss.com
+ </email>
+ </author>
+
+ <author>
+ <firstname>
+ Scott
+ </firstname>
+
+ <surname>
+ Mumford
+ </surname>
+
+ <email>
+ smumford(a)redhat.com
+ </email>
+ </author>
+ </authorgroup>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/Developer_Guide.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/Developer_Guide.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/Developer_Guide.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,13 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<book>
- <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="chapter-1-GDG_Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="chapter-2-GDG_Architectural_choices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="chapter-3-GDG_Design_choices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="chapter-4-GDG_Portal_Development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="chapter-5-GDG_Application_development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
+ <book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="chapter-1-GDG_Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="chapter-2-GDG_Architectural_choices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="chapter-3-GDG_Design_choices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="chapter-4-GDG_Portal_Development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="chapter-5-GDG_Application_development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </book>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/Preface.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/Preface.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/Preface.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,11 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-
-<preface id="pref-Developer_Guide-Preface">
- <title>Preface</title>
- <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>
-</preface>
-
+ <preface id="pref-Developer_Guide-Preface">
+ <title>Preface</title>
+
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude">
+ <xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
+ </preface>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-1-GDG_Introduction.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,7 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="sid-819799">
-
- <title>Introduction</title>
- <para>This is the EPP Developer Guide. This document is intended for those developing applications and gadgets for the EPP product and outlines options and strategies for successful deployment.</para>
- </chapter>
+ <chapter id="sid-819799">
+ <title>Introduction</title>
+
+ <para>
+ This is the JBoss Enterprise Portal Platform Developer Guide. This document is intended for those developing applications and gadgets for the JBoss Enterprise Portal Platform product and outlines options and strategies for successful deployment.
+ </para>
+ </chapter>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-2-GDG_Architectural_choices.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,91 +1,169 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="sid-7372876">
-
- <title>Architectural choices</title>
- <para>Depending on environment and goals, decisions has to be made regarding the components that will make up the final website. Some elements may already be in place (such as an identity server) and some elements may still be free to choose. This section aims at helping taking the right decisions.</para>
- <section id="sid-7372876_GDG-Architecturalchoices-Identityserver">
-
- <title>Identity server</title>
- <para>EPP 5.2 comes with a component named PicketLink IDM, which is made to adapt to store and retrieve users and groups from various identity servers. We can separate the different options into three:</para>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="strong">Database</emphasis>
- : users, groups and their relationships are stored in a RDBMS database. Tables names and column names can be changed, but the overall relationship between tables remains the same. This solution is particularly adapted to a new identity server that will handle thousands of users.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="strong">LDAP</emphasis>
- : users, groups and their relationships are stored in an LDAP (or ActiveDirectory) server, the directory structure can be adapted by configuration to the most common scenarios. This solution is particularly adapted to infrastructure that are already using an LDAP server, for infrastructure that will share the server identity among multiple service (and the website being one of them) or for very large set of users (millions). When using LDAP with large number of users, it is recommended to use LDAP tools to do the provisioning of users.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="strong">Custom</emphasis>
- : when retrieving users, groups and their relationship cannot be done by configuration, it is possible to implement the Picketlink IDM SPI to implement the methods in charge of retrieving and storing user information.
- </para>
- </listitem>
- </orderedlist>
+ <chapter id="sid-7372876">
+ <title>Architectural choices</title>
+
<para>
- Picketlink IDM also supports mix environments, this is very useful when an LDAP infrastructure is provided but in a read-only mode. Since the website may need to store additional information about users (such as his preferred language or skin), it can combine LDAP + Database, to retrieve users from LDAP but store additional properties in a database. During the calls to the identity API, the information from both sources will be transparently merged.
-
- For more information about PicketLink IDM, please check the EPP 5.2 reference guide and the PicketLink IDM documentation.
+ Depending on environment and goals, decisions have to be made regarding the components that will make up the final website. Some elements may already be in place (such as an identity server) and some elements may still be free to choose. This section aims at helping taking the right decisions.
</para>
- </section>
- <section id="sid-7372876_GDG-Architecturalchoices-Storage">
-
- <title>Storage</title>
- <para>
- The portal framework stores page compositions, portlet preferences, gadget code in a database through a Java Content Repository (JCR) API. A set of database servers and JDBC connectors are part of our quality assurance cycles and the certified environments are mentioned
- <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">here</ulink>
- .
- </para>
- <para>It is important to choose one of the combination or check with a Red Hat contact for specific environments that would differ from this list.</para>
- <para>The database schema will be automatically created during the very first startup of the website and then it is required that the database users has sufficient rights to create tables. This privilege can be revoked after the initial startup, also the database content can be exported and imported in a new server. This makes the installation of the product very easy in most cases.</para>
- <para>We do not provide additional recommendation to choose a database server over another as long as it is part of our certified environment.</para>
- <para>As said earlier content is stored through a JCR API, RDBMS aren't a great fit to store large files and it is possible to configure eXo JCR to store such files in the filesystem instead of database, metadata about the files would still be stored into the database. Note that if the website is running on a cluster the filesystem will need to be accessible from all nodes and a NFS solution needs to be setup. For more details see the notion of "value storage" in the reference guide.</para>
- </section>
- <section id="sid-7372876_GDG-Architecturalchoices-Cluster">
-
- <title>Cluster</title>
- <para>Clustering for failover or load-balancing requirements requires to spend more time configuring it for your environment, we made it easy to handle common situations though. There is a cost associated to clustering (EPP 5.2 has some optimization when running on a single node) but the product is designed to linearly scale up so that same performance is added every time a new node is added. All critical parts are kept in sync among nodes and the less critical ones left aside to achieve better performance. It will be equally critical that applications developed for the final websites pay the same attention when it comes to replicate data across a cluster of nodes.</para>
- <para>The number of nodes will vary a lot depending on the applications developed and used on the final website. We recommend to do early performance analysis with tools such as JMeter, Grinder etc to measure the impact of heavy loads.</para>
- <para>It is usually recommended to run a cluster to achieve high availability.</para>
- </section>
- <section id="sid-7372876_GDG-Architecturalchoices-SSO">
-
- <title>SSO</title>
- <para>
- If the website is part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to put a Single-Sign-On solution in place among them. Various SSO solutions are supported by EPP 5.2 as seen
- <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">here</ulink>
- . In some cases it can be better to have the token manager service on a specific server.
- </para>
- <para>Summary</para>
- <para>By now you should know what infrastructure you will need:</para>
- <para>- A database</para>
- <para>- Optionally LDAP, depending on your choice</para>
- <para>- Optionally NFS, depending on the configuration (mandatory on a cluster with default settings: TODO: More QA on a setup without NFS)</para>
- <para>- Optionally an SSO token service</para>
- <para>- Optionally, a cluster of nodes</para>
- <para>Here is an example of the simplest setup:</para>
- <figure>
-<title></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/7372876/simpleinfra.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Here is an example of a more complex setup:</para>
- <figure>
-<title></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/7372876/complexinfra.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- </chapter>
+
+ <section id="sid-7372876_GDG-Architecturalchoices-Identityserver">
+ <title>Identity server</title>
+
+ <para>
+ JBoss Enterprise Portal Platform &VY; comes with a component named PicketLink IDM, which is made to adapt to store and retrieve users and groups from various identity servers. We can separate the different options into three:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis role="strong">Database</emphasis> : users, groups and their relationships are stored in a RDBMS database. Table names and column names can be changed, but the overall relationship between tables remains the same. This solution is particularly adapted to a new identity server that will handle thousands of users.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="strong">LDAP</emphasis> : users, groups and their relationships are stored in an LDAP (or ActiveDirectory) server, the directory structure can be adapted by configuration to the most common scenarios. This solution is particularly suited to infrastructures that already use an LDAP server, infrastructures that will share the server identity among multiple services (and the website being one of them) or for very large sets of users (millions). When using LDAP with large number of users, it is recommended to use LDAP tools to do the provisioning of users.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="strong">Custom</emphasis> : when retrieving users, groups and their relationship cannot be done by configuration, it is possible to use the Picketlink IDM SPI to implement the methods which control retrieving and storing user information.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <para>
+ Picketlink IDM also supports mix environments, which is very useful when an LDAP infrastructure is provided in a read-only mode. Since a website may need to store additional information about users (such as their preferred language or skin), it can combine LDAP and database services to retrieve users from LDAP and store additional properties in a database. During the calls to the identity API, the information from both sources will be transparently merged.
+ </para>
+
+ <para>
+ For more information about PicketLink IDM, please check the JBoss Enterprise Portal Platform &VY; reference guide and the PicketLink IDM documentation.
+ </para>
+ </section>
+
+ <section id="sid-7372876_GDG-Architecturalchoices-Storage">
+ <title>Storage</title>
+
+ <para>
+ The portal framework stores page compositions, portlet preferences, gadget code in a database through a Java Content Repository (JCR) API. A set of database servers and JDBC connectors are part of our quality assurance cycles and the certified environments are mentioned <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">here</ulink> .
+ </para>
+
+ <para>
+ It is important to choose one of the combinations or check with a Red Hat contact for specific environments that would differ from this list.
+ </para>
+
+ <para>
+ The database schema will be automatically created during the very first start up of a website and then it is required that the database users have sufficient rights to create tables. This privilege can be revoked after the initial start up, also the database content can be exported and imported in a new server. This makes the installation of the product very easy in most cases.
+ </para>
+
+ <para>
+ We do not provide additional recommendation to choose one database server over another as long as it is one of the certified environment.
+ </para>
+
+ <para>
+ As said earlier, content is stored through a JCR API, RDBMS aren't a great fit to store large files and it is possible to configure eXo JCR to store such files in the filesystem instead of a database, whereas metadata about the files would still be stored into the database. Note that if the website is running on a cluster, the filesystem will need to be accessible from all the nodes and a NFS solution needs to be set up. For more details see the notion of "value storage" in the reference guide.
+ </para>
+ </section>
+
+ <section id="sid-7372876_GDG-Architecturalchoices-Cluster">
+ <title>Cluster</title>
+
+ <para>
+ Clustering for failover or load-balancing requirements requires spending more time configuring it for your environment, we made it easy to handle common situations though. There is a cost associated with clustering (JBoss Enterprise Portal Platform &VY; has some optimizations when running on a single node), but the product is designed to linearly scale up so that the same performance is added every time a new node is added. All critical parts are kept in sync among nodes and the less critical ones are left aside to achieve better performance. It will be equally critical that applications developed for the final websites pay the same attention when it comes to replicating data across a cluster of nodes.
+ </para>
+
+ <para>
+ The number of nodes will vary a lot depending on the applications developed and used on the final website. We recommend to do early performance analysis with tools such as JMeter, Grinder or similar to measure the impact of heavy loads.
+ </para>
+
+ <para>
+ It is usually recommended to run a cluster to achieve high availability.
+ </para>
+ </section>
+
+ <section id="sid-7372876_GDG-Architecturalchoices-SSO">
+ <title>SSO</title>
+
+ <para>
+ If a website is a part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to use a Single-Sign-On solution. Various SSO solutions are supported by JBoss Enterprise Portal Platform &VY; as seen <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">here</ulink> . In some cases it can be better to have the token manager service on a specific server.
+ </para>
+
+ <section id="sid-7372876_GDG-Architecturalchoices-Summary">
+ <title>Summary</title>
+
+ <para>
+ By now you should know what infrastructure you will need:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ A database
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Optionally LDAP, depending on your choice
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Optionally NFS, depending on the configuration (mandatory on a cluster with default settings)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Optionally an SSO token service
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Optionally a cluster of nodes
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Here is an example of the simplest set-up:
+ </para>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372876/simpleinfra.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372876/simpleinfra.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Here is an example of a more complex set-up:
+ </para>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" scale="150"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372876/complexinfra.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+ </chapter>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-3-GDG_Design_choices.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,122 +1,197 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="sid-7372952">
-
- <title>Design choices</title>
- <para>Now that the main components of the architecture has been decided, choices must be made on the overall design.</para>
- <section id="sid-7372952_GDG-Designchoices-Dashboards">
-
- <title>Dashboards</title>
- <para>User dashboards may be very costly in a website, as each user will have the opportunity to design his own personal website, it comes with the cost of storing all that information. Efforts have been made (and are still made) to reduce this cost, but there will always be an overhead.</para>
- <para>This overhead might be hard to estimate as this will depend a lot on how the users will navigate the website, maybe only a minority will use this functionality, or maybe the website is only made of dashboards. In any case the impact of making this feature available must be measured by:</para>
- <itemizedlist>
- <listitem>
- <para>estimating the number of dashboards and pages that will be created</para>
- </listitem>
- <listitem>
- <para>observing the impact on the database (through JCR) in terms of size</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="sid-7372952_GDG-Designchoices-JCRindexreplicationforclustersetup">
-
- <title>JCR index replication for cluster setup</title>
+ <chapter id="sid-7372952">
+ <title>Design choices</title>
+
<para>
- The JCR implementation uses Apache Lucene for indexing the data. The indexes are used to search for content (It can be page nodes or WCM content for instance).
-
- Lucene isn't cluster-ready but on a cluster, each node will need to be able to search for content and will need to have access to the lucene indexes.
-
- When is comes to searching, there is always a tradeoff. Everyone would want to achieve all of the following:
+ Now that the main components of the architecture have been decided, choices must be made on the overall design.
</para>
- <itemizedlist>
- <listitem>
- <para>Fast to search</para>
- </listitem>
- <listitem>
- <para>Fast to index</para>
- </listitem>
- <listitem>
- <para>Same search result on each node at the same time</para>
- </listitem>
- <listitem>
- <para>No need to rebuild the index ever (No inconsistency)</para>
- </listitem>
- <listitem>
- <para>No impact on overall performance</para>
- </listitem>
- <listitem>
- <para>Easy to setup (no infrastructure change)</para>
- </listitem>
- </itemizedlist>
- <para>But there are choices to be made. The JCR implementation used by EPP (eXo JCR) makes it possible to configure the storage and retrieval of indexes according to architect's choice on where it is acceptable to lose-up some constraints. For configuration details please refer to the EPP Reference Guide.</para>
- <section id="sid-7372952_GDG-Designchoices-Standaloneindex">
-
- <title>Standalone index</title>
- <para>
- This is only for a non-cluster environment, this is obviously the easiest setup, with a combination of in-memory and file based indexes. There is no replication involved so any entry can be found by a search as soon as they are created.
- <figure>
-<title>TODO Gliffy image title empty</title>
-<mediaobject>
-<imageobject>
- <imagedata fileref="images/7372952/diagram-standalone-index.png"/>
- </imageobject>
-</mediaobject>
-</figure>
- </para>
- </section>
- <section id="sid-7372952_GDG-Designchoices-Localindex">
-
- <title>Local index</title>
- <para>
- This environment is easy to setup, each node keeps a local copy of the full indexes so that when a search is requested on a node, there is no network communication requested. The downside is that when a node indexes an item, it requires to replicate that index on each and every node. If a node is unavailable at that time, it may miss an index update request and then the different nodes may be inconsistent.
+
+ <section id="sid-7372952_GDG-Designchoices-Dashboards">
+ <title>Dashboards</title>
- Also when a node is added it has to recreate it's own full index.
+ <para>
+ User dashboards may be very costly in a website. Each user has an opportunity to design his own personal website, it comes with the cost of storing all that information. Efforts have been made (and are still being made) to reduce this cost, but there will always be an overhead.
+ </para>
- An alternative to this setup is to ask a node to retrieve the info from a coordinator on each search, it makes the startup of the new node faster but impacts its performance during the runtime. This setup is new to EPP 5.2.
- </para>
- <para>
- <figure>
-<title>TODO InformalFigure image title empty</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/7372952/diagram-local-index.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </para>
+ <para>
+ This overhead might be hard to estimate as this will depend a lot on how the users will navigate through the website. Maybe only a minority will use this functionality, or maybe the website is only made of dashboards. In any case the impact of making this feature available must be measured by:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ estimating the number of dashboards and pages that will be created
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ observing the impact on the database (through JCR) in terms of size
+ </para>
+ </listitem>
+ </itemizedlist>
</section>
- <section id="sid-7372952_GDG-Designchoices-Sharedindex">
-
- <title>Shared index</title>
- <para>
- In this setup there is a unique index created and shared among all nodes. It requires to configure the infrastructure so that a network file system is installed where all nodes can read content.
+
+ <section id="sid-7372952_GDG-Designchoices-JCRindexreplicationforclusterset-up">
+ <title>JCR index replication for cluster set-up</title>
- Advantages:
- </para>
- <itemizedlist>
- <listitem>
- <para>Consistency, all the nodes see the same data</para>
- </listitem>
- </itemizedlist>
- <para>Drawback:</para>
- <itemizedlist>
- <listitem>
- <para>Requires a highly available NFS setup (NFS 4 is recommended)</para>
- </listitem>
- <listitem>
- <para>More network communication</para>
- </listitem>
- </itemizedlist>
- <para>
- <figure>
-<title>TODO InformalFigure image title empty</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/7372952/diagram-shared-index.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </para>
+ <para>
+ The JCR implementation uses Apache Lucene for indexing the data. The indexes are used to search for content (It can be page nodes or WCM content for instance).
+ </para>
+
+ <para>
+ Lucene isn't cluster-ready, but on a cluster, each node will need to be able to search for content and will need to have access to the lucene indexes.
+ </para>
+
+ <para>
+ When is comes to searching, there is always a tradeoff. Everyone would want to achieve all of the following:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Fast to search
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Fast to index
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Same search result on each node at the same time
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ No need to rebuild the index ever (No inconsistency)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ No impact on overall performance
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Easy to set-up (no infrastructure change)
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ But there are choices to be made. The JCR implementation used by JBoss Enterprise Portal Platform (eXo JCR) makes it possible to configure the storage and retrieval of indexes according to architect's choice on where it is acceptable to relax some constraints. For configuration details please refer to the JBoss Enterprise Portal Platform Reference Guide.
+ </para>
+
+ <section id="sid-7372952_GDG-Designchoices-Standaloneindex">
+ <title>Standalone index</title>
+
+ <para>
+ This is only for a non-cluster environment, this is obviously the easiest set-up, with a combination of in-memory and file based indexes. There is no replication involved so any entry can be found by a search as soon as it is created.
+ </para>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372952/diagram-standalone-index.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372952/diagram-standalone-index.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="sid-7372952_GDG-Designchoices-Localindex">
+ <title>Local index</title>
+
+ <para>
+ This environment is easy to set up, each node keeps a local copy of the full indexes so that when a search is requested on a node, there is no network communication required. The downside is that when a node indexes an item, it is required to replicate that index on each and every node. If a node is unavailable at that time, it may miss an index update request and then the different nodes may be inconsistent.
+ </para>
+
+ <para>
+ Also when a node is added, it has to recreate it's own full index.
+ </para>
+
+ <para>
+ An alternative to this set-up is to ask a node to retrieve the info from a coordinator on each search, which makes the startup of the new node faster, but impacts its performance during the runtime. This set-up is new to JBoss Enterprise Portal Platform &VY;.
+ </para>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372952/diagram-local-index.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372952/diagram-local-index.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="sid-7372952_GDG-Designchoices-Sharedindex">
+ <title>Shared index</title>
+
+ <para>
+ In this set-up there is a unique index created and shared among all the nodes. It is required to configure the infrastructure so that a network file system is installed where all nodes can read content.
+ </para>
+
+ <para>
+ Advantages:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Consistency, all the nodes see the same data
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Drawback:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Requires a highly available NFS set-up (NFS 4 is recommended)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ More network communication
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372952/diagram-shared-index.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372952/diagram-shared-index.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</section>
- </section>
- </chapter>
+ </chapter>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,79 +1,124 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="sid-8094155">
-
- <title>Portal Development</title>
- <section id="sid-7372962">
-
- <title>Portal containers</title>
- <para>In a single instance (or cluster) of EPP, multiple portals can be running and share resources with other portals with two level of granularities:</para>
- <itemizedlist>
- <listitem>
- <para>Portal Containers: A portal container can host multiple sites, and an EPP instance can host multiple portal containers</para>
- </listitem>
- <listitem>
- <para>Site: A site can have a unique identity, with its own skin applied, set of pages...</para>
- </listitem>
- </itemizedlist>
- <para>
- The biggest granularity is what is called "Portal Containers", a Portal Container can host multiple "Sites". Those two components have a unique identifier that can be found in the default URL Mapping according to the following scheme:
- <ulink url="http://localhost:8080/"/>
- <portalcontainer>/<site>
- </para>
- <para>
- When creating a website, it is possible to create a portal container from scratch or extend an existing one. It is then possible to extend the portal container which is accessed at
- <ulink url="http://localhost:8080/portal"/>
- on the out of the box solution, this is the recommended way. While running multiple portal containers is possible, it's usually better to keep those on separate installation, note that multiple websites can run in a single portal container and share some services.
- </para>
- <para>
- By providing an extension you can benefit from the portal provided by EPP and be able to customize the parts you want. The benefits over directly modifying the shipped files is that it will make the updates much easier (By just replacing the archives provided by EPP).
- <figure>
-<title>TODO Gliffy image title empty</title>
-<mediaobject>
-<imageobject>
- <imagedata fileref="images/7372962/portalextensionstructure.png"/>
- </imageobject>
-</mediaobject>
-</figure>
- </para>
- <section id="sid-7372962_GDG-Portalcontainers-Portalextension">
-
- <title>Portal extension</title>
- <para>A portal extension is packaged as an Enterprise ARchive (EAR), a configuration file allows to define which services are required and by ordering those, it is possible to modify some elements. It can be a configuration setting, a translation, a visual template, a page to add...</para>
- <para>
- Portal extensions can shadow existing services, a portal will usually be composed of various extensions, each of them usually add services.
- <figure>
-<title>TODO Gliffy image title empty</title>
-<mediaobject>
-<imageobject>
- <imagedata fileref="images/7372962/portalExtensions.png"/>
- </imageobject>
-</mediaobject>
-</figure>
- In a portal extension, elements are shadowed by using the same directory location, so if one wants to rewrite the groovy template of the HomePagePortlet which is located in: gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl it would be located in an extension such as myExtension/myWar.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl. The ordering will be defined by the portal extension configuration.
- </para>
+ <chapter id="sid-8094155">
+ <title>Portal Development</title>
+
+ <section id="sid-7372962">
+ <title>Portal containers</title>
+
+ <para>
+ In a single instance (or cluster) of JBoss Enterprise Portal Platform, multiple portals can be running and share resources with other portals with two level of granularity:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Portal Containers: A portal container can host multiple sites, and an JBoss Enterprise Portal Platform instance can host multiple portal containers
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Site: A site can have a unique identity, with its own skin applied to a set of pages.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The biggest granularity is what is called "Portal Containers". A Portal Container can host multiple "Sites". Those two components have a unique identifier that can be found in the default URL mapping according to the following scheme: <code> <ulink url="http://localhost:8080/"/> <portalcontainer>/<site> </code>
+ </para>
+
+ <para>
+ When creating a website, it is possible to create a portal container from scratch or extend an existing one. It is then possible to extend the portal container which is accessed at <ulink url="http://localhost:8080/portal"/> on the out of the box solution, this is the recommended way. While running multiple portal containers is possible, it's usually better to keep those on separate installation. Note that multiple websites can run in a single portal container and share some services.
+ </para>
+
+ <para>
+ By providing an extension you can benefit from the portal provided by JBoss Enterprise Portal Platform and be able to customize the parts you want. The benefit over directly modifying the shipped files is that it will make the updates much easier (by just replacing the archives provided by JBoss Enterprise Portal Platform).
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372962/portalextensionstructure.png" format="PNG" align="center" scale="100"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372962/portalextensionstructure.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </para>
+
+ <section id="sid-7372962_GDG-Portalcontainers-Portalextension">
+ <title>Portal extension</title>
+
+ <para>
+ A portal extension is packaged as an Enterprise ARchive (EAR), a configuration file allows to define which services are required and by ordering those, it is possible to modify some elements. It can be a configuration setting, a translation, a visual template, a page to add.
+ </para>
+
+ <para>
+ Portal extensions can shadow existing services, a portal will usually be composed of various extensions, which usually add services.
+ </para>
+
+ <figure>
+ <title>Example</title>
+
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" scale="10"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="images/7372962/portalExtensions.png" format="PNG" align="center" width="150mm"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In a portal extension, elements are shadowed by using the same directory location, so if you want to rewrite the groovy template of the HomePagePortlet which is located in <filename>gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>, it would be in an extension at a location such as <filename>myExtension/myWar.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>. The ordering will be defined by the portal extension configuration.
+ </para>
+ </section>
</section>
- </section>
- <section id="sid-8094158">
-
- <title>Visual identity</title>
- <para>A portal visual identity will be made of the HTML produced by the result of the portal aggregation (the components that makes a page like columns, rows combined with the content produced by the portlets) and associated CSS files.</para>
- <para>EPP allows to deploy multiple skins which consists of CSS files, it makes it possible to apply styling on the page compositions and components of a page (Portlets). Different skins can be applied to the different websites, also if made available to the users, they can choose their preferred skin.</para>
- <section id="sid-8094158_GDG-Visualidentity-Customizingtheloginpage">
-
- <title>Customizing the login page</title>
- <para>When accessing a page that requires privileges, a login page is showing up, that page can be customized by using an extension. To do so it would be enough to copy the file located at:</para>
- <example>
- <title>Login JSP</title>
- <programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting>
- </example>
- <para>and include it in the portal extension such as myExtension.ear/myWar.war/login/jsp/login.jsp</para>
- <para>All the logic must be carefully kept in the login page so that the portal will keep working as it should.</para>
- <para>To modify the modal window which pops up when the user decides to sign-in, the extension would have a modified copy of:</para>
- <example>
- <title>Login Form</title>
- <programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting>
- </example>
+
+ <section id="sid-8094158">
+ <title>Visual identity</title>
+
+ <para>
+ A portal visual identity is made of HTML produced as a result of portal aggregation (the components that make a page like columns and rows combined with the content produced by the portlets) and associated CSS files.
+ </para>
+
+ <para>
+ JBoss Enterprise Portal Platform allows to deploy multiple skins consisting of CSS files, which makes it possible to apply styling to the page compositions and components of a page (portlets). Different skins can be applied to the different websites, also if made available to the users, they can choose their preferred skin.
+ </para>
+
+ <section id="sid-8094158_GDG-Visualidentity-Customizingtheloginpage">
+ <title>Customizing the login page</title>
+
+ <para>
+ When accessing a page that requires privileges, a login page is shown and it can be customized by using an extension. To do so, it would be enough to copy the file located at:
+ </para>
+
+ <example>
+ <title>Login JSP</title>
+<programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting>
+ </example>
+
+ <para>
+ and include it in a portal extension such as myExtension.ear/myWar.war/login/jsp/login.jsp
+ </para>
+
+ <para>
+ All the logic must be carefully kept in the login page so that the portal will keep working as it should.
+ </para>
+
+ <para>
+ To modify the modal window which pops up when the user decides to sign-in, the extension would have a modified copy of:
+ </para>
+
+ <example>
+ <title>Login Form</title>
+<programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting>
+ </example>
+ </section>
</section>
- </section>
- </chapter>
+ </chapter>
Modified: epp/docs/branches/5.2/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/5.2/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2011-12-08 22:40:29 UTC (rev 8219)
+++ epp/docs/branches/5.2/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2011-12-09 00:50:40 UTC (rev 8220)
@@ -1,33 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="sid-819803">
-
- <title>Application development</title>
- <section id="sid-819807">
-
- <title>Gadget Development</title>
- <section id="sid-819807_GDG-GadgetDevelopment-Introduction">
-
- <title>Introduction</title>
- <para>In the context of EPP, gadgets are those as defined by the Google OpenSocial specifications. Since EPP 5.2, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial.</para>
- <para>Within a portal it is possible to embed any OpenSocial gadget on a page or within the user dashboards, gadgets can be added to the application registry, or links can be added within the mini-composer (see the User Guide).</para>
+ <chapter id="sid-819803">
+ <title>Application development</title>
+
+ <section id="sid-819807">
+ <title>Gadget Development</title>
+
+ <section id="sid-819807_GDG-GadgetDevelopment-Introduction">
+ <title>Introduction</title>
+
+ <para>
+ In the context of JBoss Enterprise Portal Platform, gadgets are defined by the Google OpenSocial specifications. Since JBoss Enterprise Portal Platform &VY;, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial.
+ </para>
+
+ <para>
+ Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user's dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the JBoss Enterprise Portal Platform User Guide).
+ </para>
+ </section>
+
+ <section id="sid-819807_GDG-GadgetDevelopment-DevelopingGadgets">
+ <title>Developing Gadgets</title>
+
+ <para>
+ OpenSocial gadgets are made of standard HTML and javascript. The container offers an API, the documentation for which is available <ulink url="http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Gadget.xml">here</ulink> .
+ </para>
+
+ <para>
+ Note that, unlike portlets, a gadget has very little knowledge of its context (the portal) and its integration within the portal may be more limited (in terms of visual integration for instance).
+ </para>
+
+ <para>
+ While Google Web Toolkit (GWT) applications can also technically be used as gadgets and GWT makes it easy to write user-friendly applications, we do not recommend its usage as its support can be limited and Google's strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently, GWT applications are not supported by the JBoss Enterprise Portal Platform support agreement.
+ </para>
+ </section>
</section>
- <section id="sid-819807_GDG-GadgetDevelopment-DevelopingGadgets">
-
- <title>Developing Gadgets</title>
- <para>
- OpenSocial gadgets are made of standard HTML and javascript. The container offers an API for which the documentation is available
- <ulink url="http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Gadget.xml">here</ulink>
- .
- </para>
- <para>Note that unlike portlets, a gadget has very little knowledge of its context (the portal) and its integration within the portal may be more limited (in terms of visual integration for instance).</para>
- <para>While Google Web Toolkit (GWT) applications can also technically be used as gadgets and makes it easy to write user-friendly applications, we do not recommend its usage as its support can be limited and Google's strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently GWT applications are not supported by the EPP support agreement.</para>
+
+ <section id="sid-819805">
+ <title>Portlet Development</title>
+
+ <para>
+ JBoss Enterprise Portal interface is fully customized with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the "Portlet Primer" chapter in the JBoss Enterprise Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JSF and/or RichFaces and/or Seam, (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Enterprise Portal Platform Reference Guide).
+ </para>
+
+ <para>
+ Depending on the complexity of the application and the familiarity of the team with JSF, one approach or the other can be the right choice for your team.
+ </para>
</section>
- </section>
- <section id="sid-819805">
-
- <title>Portlet Development</title>
- <para>JBoss Enterprise Portal interface is fully customized with applications called portlets. Application development can be done by using the plain Portlet specification (JSR-286) (See the "Portlet Primer" chapter in the reference guide) but it is also possible to use the JBoss Portlet Bridge to write applications with JSF and/or RichFaces and/or Seam, see the "Getting started with JBoss Portlet Bridge" chapter of the reference guide.</para>
- <para>Depending on the complexity of the application and the familiarity of the team with JSF, one approach or the other can be the right choice for your team.</para>
- </section>
- </chapter>
+ </chapter>
13 years
- 1
- 0