7:37 a.m.
Author: emuckenhuber
Date: 2007-09-19 08:37:41 -0400 (Wed, 19 Sep 2007)
New Revision: 8360
Modified:
docs/trunk/referenceGuide/en/modules/identityportlets.xml
docs/trunk/userGuide/en/modules/intro.xml
docs/trunk/userGuide/en/modules/user_role.xml
Log:
- identity portlet related changes
Modified: docs/trunk/referenceGuide/en/modules/identityportlets.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/identityportlets.xml 2007-09-19 12:26:20 UTC (rev
8359)
+++ docs/trunk/referenceGuide/en/modules/identityportlets.xml 2007-09-19 12:37:41 UTC (rev
8360)
@@ -189,8 +189,12 @@
</itemizedlist>
</para>
<note>
- Defining the subscription mode has to be done in the configuration file as explained
here: <xref linkend="identity_portlet_configuration_file"/>. It is not
recommended to change the subscription mode during runtime.
+ The subscription mode has to be defined in the configuration file as explained here:
<xref linkend="identity_portlet_configuration_file"/>.
</note>
+ <warning>
+ Make sure that the application server is restarted after changing the Identity
Portlets. Hot re-deployment can result in a
+ strange behavior with jBPM (e.g. empty pending user list).
+ </warning>
<para></para>
<mediaobject>
<imageobject>
@@ -476,12 +480,9 @@
...
]]></programlisting>
<para>
- For localization, we can use the resource bundle: in e.g.
- <emphasis>
- portal-identity.sar/conf/bundles/Identity.properties
- </emphasis>
- - The value will only be used if the element does not
- have any localization information.
+ For localizing dynamic values it is also possible to use the resource bundle.
+ This can be done by adding the key with a prefix (to i.e.
<emphasis>Identity.properties</emphasis>) like in the following listing.
+ The key will be stored in the users property and is used to identify the element. The
value of the configuration file will only be used if no localization information is found.
</para>
<programlisting><![CDATA[
...
Modified: docs/trunk/userGuide/en/modules/intro.xml
===================================================================
--- docs/trunk/userGuide/en/modules/intro.xml 2007-09-19 12:26:20 UTC (rev 8359)
+++ docs/trunk/userGuide/en/modules/intro.xml 2007-09-19 12:37:41 UTC (rev 8360)
@@ -268,7 +268,7 @@
</para>
</sect3>
<sect3 id="intro_user_portlet">
- <title>User Portlet</title>
+ <title>Identity User Portlet</title>
<note>Administrators should view <xref
linkend="useradmin"/> for managing the portal user base. Only user
operations are covered in this section...
</note>
@@ -289,15 +289,15 @@
valign="middle"/>
</imageobject>
</mediaobject>
- The User Portlet allows a user to:
+ The Identity User Portlet allows a user to:
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Create a new
account</emphasis>
</para>
<para>
- Create a new account by clicking on the <emphasis>"You
can create an account"</emphasis>
- link at the bottom of the portlet, when not logged. A User can
then fill in the necessary
+ Create a new account by clicking on the
<emphasis>"Register"</emphasis>
+ link in the navigation of the portlet, when not logged. A User
can then fill in the necessary
information to create an account on the system:
<mediaobject>
<imageobject>
@@ -308,11 +308,29 @@
</para>
</listitem>
<listitem>
+ <para>
+ <emphasis role="bold">Lost password</emphasis>
+ </para>
+ <para>
+ Already registered users can request a new password by clicking on
the <emphasis>"Lost password"</emphasis> link
+ in the navigation of the portlet. Therfore the user needs to fill in
his user name to receive an e-mail with his new
+ login credentials.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">View profile</emphasis>
+ </para>
+ <para>
+ The default page after login is the view profile, which shows a
summary of the most important properties of a user.
+ </para>
+ </listitem>
+ <listitem>
<para>
<emphasis role="bold">Edit personal
information</emphasis>
</para>
- <para>A user has the ability to edit his personal information
at any time by clicking on the
- <emphasis>"Edit your profile"</emphasis>
link, when logged in.
+ <para>A user has the ability to edit his personal information,
change his password and e-mail address at any time by clicking on the
+ <emphasis>"Edit profile"</emphasis> link,
when logged in.
</para>
</listitem>
</itemizedlist>
Modified: docs/trunk/userGuide/en/modules/user_role.xml
===================================================================
--- docs/trunk/userGuide/en/modules/user_role.xml 2007-09-19 12:26:20 UTC (rev 8359)
+++ docs/trunk/userGuide/en/modules/user_role.xml 2007-09-19 12:37:41 UTC (rev 8360)
@@ -8,29 +8,28 @@
</author>
</chapterinfo>
<title>Administration - Users and Roles</title>
+ <para>
+ This chapter covers the administrator functions made available by the User management
portlet. For end-user operation, see:
+ <xref linkend="intro_user_portlet"/>. Administrative functions
are available once you are logged in with the proper
+ credentials (admin/admin), then going to the <xref
linkend="adminportal"/> and then the Members Page tab. You can change
between
+ user and role management by clicking on the corresponding links in the top of the
portlet.
+ </para>
<sect1 id="useradmin">
<title>Managing Users</title>
- <sect2>
- <title>Introduction</title>
- <para>This section covers the administrator functions made available by
the UserPortlet. For end-user
- operation, see:
- <xref linkend="intro_user_portlet"/>
- . Administrative functions are available once you are logged in with the
proper credentials (admin/admin),
- then going to the
- <xref linkend="adminportal"/>
- and then the Members Page tab.
+ <para>
+ This section covers the user management of the IdentityUserManagementPortlet
which is displayed by default.
+ For role management please see <xref linkend="roleadmin"/>.
<mediaobject>
<imageobject>
<imagedata fileref="images/role/memberspage.gif"
format="gif" align="center" valign="middle"/>
</imageobject>
</mediaobject>
</para>
- </sect2>
<sect2>
<title>Actions</title>
- <para>All administrative functions are available after clicking on the
'
- <emphasis>List of all users</emphasis>
- ' link.
+ <para>The first page of the user management portlet displays some user
related actions (eg. Search users, Create new user account)
+ and some additional information (e.g. Registered users and Subscription mode).
The registered users represent the count of all registered users
+ and the subscription mode describes the required tasks for registering (i.e. first
e-mail validation and then approval by the administrator).
<mediaobject>
<imageobject>
<imagedata fileref="images/role/user_ss.gif"
format="gif" align="center" valign="middle"/>
@@ -40,7 +39,7 @@
<sect3 id="searchingusers">
<title>Searching for Users</title>
<para>
- Typing a partial username in the form text field, allows you to search for
usernames matching that
+ For searching users click on the link <emphasis>Search
users</emphasis> and then type a partial username in the form text field, to search
for usernames matching that
criteria.
<mediaobject>
<imageobject>
@@ -52,7 +51,7 @@
<sect3 id="updatingusers">
<title>Updating User Profiles</title>
<para>Clicking on the
- <emphasis>Profile</emphasis>
+ <emphasis>Edit user</emphasis>
link on the search page will allow you to edit a user's profile data,
and even reset his password.
<mediaobject>
<imageobject>
@@ -86,16 +85,27 @@
</mediaobject>
</para>
</sect3>
+ <sect3 id="pendingusers">
+ <title>Pending users</title>
+ <para>
+ Click on the <emphasis>Show pending registrations</emphasis> link
to show all registrations with validated e-mail addresses.
+ You can approve or reject each user by clicking on the corresponding action or
click on <emphasis>select all</emphasis>
+ to approve or reject all selected users.
+ </para>
+ </sect3>
</sect2>
</sect1>
<sect1 id="roleadmin">
<title>Managing Roles</title>
+ <para>
+ The User management portlet is also responsible to create and edit roles and it is
accessible once logged in as described in the previous when clicking on the
<emphasis>role management</emphasis>
+ link in the User management portlet.
+ </para>
<sect2>
<title>Introduction</title>
- <para>The role portlet is dedicated to create and edit roles. A role will
be used to grant
- different permission level to different portlets, pages, or portal instances.
A user can have several roles.
+ <para> A role will be used to grant different permission level to
different portlets, pages, or portal instances. A user can have several roles.
</para>
- <para>The RolePortlet is accessible once logged in as an administrator
(admin/admin) from the Admin Page
+ <para>
<imageobject>
<imagedata fileref="images/role/normalstate.gif"
format="gif" align="center" valign="middle"/>
<caption>Normal state</caption>
@@ -104,12 +114,15 @@
</sect2>
<sect2>
<title>Actions</title>
+ <para>
+ The User management portlet also provides several actions related to role
management, which are described in the following sections.
+ </para>
<sect3 id="createrole">
<title>Creating Roles</title>
<para>
Creating new roles, is accomplished by first clicking on the
- <emphasis>Create New Role</emphasis>
- link in the RolePortlet.
+ <emphasis>Create new role</emphasis>
+ link in the portlet.
<mediaobject>
<imageobject>
<imagedata fileref="images/role/createrole.gif"
format="gif" align="center" valign="middle"/>
@@ -127,15 +140,13 @@
<sect3 id="editrole">
<title>Edit a role</title>
<para>
- Editting roles, is accomplished by first clicking the name of the role you
want to edit in the
- RolePortlet.
+ Editting roles, is accomplished by clicking on <emphasis>Edit
role</emphasis> in the row of the role you want to edit.
<mediaobject>
<imageobject>
<imagedata fileref="images/role/editrolename.gif"
format="gif" align="center" valign="middle"/>
</imageobject>
</mediaobject>
- While editing a role, you just need to pick an exising role then change
the
- display name. Additionally, you can delete existing roles from this
screen.
+ While editing a role, you just need to pick an exising role then change
the display name.
</para>
</sect3>
<sect3 id="editrolemembers">
@@ -143,16 +154,13 @@
<para>
Editting role members, is accomplished by first clicking the
<emphasis>Members</emphasis>
- link in the
- RolePortlet for the role you would like to modify.
+ link at the role management page for the role you would like to modify.
<mediaobject>
<imageobject>
- <imagedata fileref="images/role/edituserroles.gif"
format="gif" align="center"
- valign="middle"/>
+ <imagedata fileref="images/role/edituserroles.gif"
format="gif" align="center" valign="middle"/>
</imageobject>
</mediaobject>
- Allows for an administrator to search and modify the members'
assigned
- roles.
+ Allows for an administrator to search and modify the members' assigned
roles.
</para>
</sect3>
<sect3 id="deleteroles">
@@ -160,8 +168,7 @@
<para>
Deleting roles is accomplished by clicking the
<emphasis>Delete</emphasis>
- link in the
- RolePortlet for the role you would like to remove.
+ link for the role you would like to remove.
</para>
</sect3>
</sect2>