Author: emuckenhuber Date: 2007-09-21 07:58:37 -0400 (Fri, 21 Sep 2007) New Revision: 8401 Added: docs/trunk/userGuide/en/images/role/user_pending.png Modified: docs/trunk/referenceGuide/en/modules/identityportlets.xml docs/trunk/userGuide/en/modules/user_role.xml Log: - identity portlet docs update Modified: docs/trunk/referenceGuide/en/modules/identityportlets.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/identityportlets.xml 2007-09-21 11:11:51 UTC (rev 8400) +++ docs/trunk/referenceGuide/en/modules/identityportlets.xml 2007-09-21 11:58:37 UTC (rev 8401) @@ -25,7 +25,7 @@ Portlet contains all the functionality for managing users and roles. </para> <warning> - The identity portlets will evolve over time, therefore usage and + The Identity portlets will evolve over time, therefore usage and configuration might change. </warning> <sect2> @@ -192,8 +192,8 @@ 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). + Make sure that the application server is restarted after re-deploying the Identity Portlets. This is required to make sure that + the registration process works properly! </warning> <para></para> <mediaobject> @@ -392,7 +392,7 @@ <sect2 id="identity_portlet_configuration_example1"> <title>Example 1: required fields</title> <para> - This example explains how to changed optional properties to + This example explains how to change optional properties to required properties, of course once this is done, we will also need to add the corresponding fields in the registration page. <sbr /> @@ -433,7 +433,7 @@ ...]]></programlisting> <para> That's it - from now on the given name and family name will be - required on registration. You may also want to add this piece of code on the edit profile page. + required on registration. We dynamically obtain the values from the descriptor. Now if i just wanted to make them back to optional, i would change the values only in the descriptor, letting the user enter or not those values. </para> @@ -544,8 +544,7 @@ ]]></programlisting> <note> The property-ref must match a property from the - <emphasis>profile-config.xml</emphasis> - . + <emphasis>profile-config.xml</emphasis>. </note> <para> <emphasis role="bold">step 3:</emphasis> @@ -690,10 +689,10 @@ </sect1> <sect1> <title>Customizing the workflow</title> - <note><para>For more details about jBPM please read the jBPM documentation</para></note> + <note><para>For more details about jBPM please read the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/index.html">jBPM documentation</ulink></para></note> <para> The process definitions are located in: - <emphasis>portal-identity.sar/conf/processes</emphasis>. To create a custom workflow , the workflow <emphasis>custom.xml</emphasis> can be extended. + <emphasis>portal-identity.sar/conf/processes</emphasis>. To create a custom workflow, you can extend the existing process description file: <emphasis>custom.xml</emphasis>. </para> <para> Available variables in the business process: @@ -707,7 +706,7 @@ <emphasis>java.lang.String</emphasis> <sbr /> <emphasis role="bold">description:</emphasis> - the full url of the portal e.g. + represents the full url of the portal e.g. <emphasis> http://localhost:8080/portal </emphasis> @@ -808,7 +807,7 @@ <para> Due to the fact that the former user portlets are still included in JBoss Portal 2.6.2 it is possible to activate - it over the Portal Admin interface, by using the PortletInstances: + it in the Portal Admin interface, by using the PortletInstances: <itemizedlist> <listitem> <emphasis>UserPortletInstance:</emphasis> The former user portlet @@ -822,8 +821,8 @@ <title>Enabling the Identity Portlets</title> <para> When migrating from former versions of JBoss Portal the Identity User Portlets won't be displayed by default, - but Windows can be created on basis of the existing Portlet Instances which are by default deployed. (The instances - names being <literal>IdentityUserPortletInstance</literal> and <literal>IdentityAdminPortletInstance</literal>. + but Windows can be created on basis of the existing Portlet Instances which are deployed by default. (The instances + names being <literal>IdentityUserPortletInstance</literal> and <literal>IdentityAdminPortletInstance</literal>). </para> </sect2> </sect1> Added: docs/trunk/userGuide/en/images/role/user_pending.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/role/user_pending.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/trunk/userGuide/en/modules/user_role.xml =================================================================== --- docs/trunk/userGuide/en/modules/user_role.xml 2007-09-21 11:11:51 UTC (rev 8400) +++ docs/trunk/userGuide/en/modules/user_role.xml 2007-09-21 11:58:37 UTC (rev 8401) @@ -6,6 +6,11 @@ <surname>Russo</surname> <email&gt;roy(a)jboss.org&lt;/email&gt; </author> + <author> + <firstname>Emanuel</firstname> + <surname>Muckenhuber</surname> + <email&gt;emuckenh(a)redhat.com&lt;/email&gt; + </author> </chapterinfo> <title>Administration - Users and Roles</title> <para> @@ -23,17 +28,29 @@ <imageobject> <imagedata fileref="images/role/memberspage.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + The Members page in the <xref linkend="adminportal"/>. + </para> + </caption> </mediaobject> </para> <sect2> <title>Actions</title> <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). + and the subscription mode describes the required tasks for registering a user (i.e. first e-mail validation and then approval by the administrator). + The <emphasis>Subscription mode</emphasis> symbolizes the mode used in the User portlet. The <emphasis>Admin subscription mode</emphasis> represents + the mode used in the User management portlet. <mediaobject> <imageobject> <imagedata fileref="images/role/user_management.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + The User management portlet. + </para> + </caption> </mediaobject> </para> <sect3 id="searchingusers"> @@ -45,6 +62,11 @@ <imageobject> <imagedata fileref="images/role/user_su.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + The search users page. + </para> + </caption> </mediaobject> </para> </sect3> @@ -57,6 +79,11 @@ <imageobject> <imagedata fileref="images/role/edit_profile.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Editing a users profile. + </para> + </caption> </mediaobject> </para> </sect3> @@ -64,11 +91,16 @@ <title>Updating User Roles</title> <para>Clicking on the <emphasis>Roles</emphasis> - link in the search page allows you to modify the roles the specific user belongs to. + link in the search page allows you to modify the roles a specific user belongs to. <mediaobject> <imageobject> <imagedata fileref="images/role/assign_roles.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Assign roles to a user. + </para> + </caption> </mediaobject> </para> </sect3> @@ -82,6 +114,11 @@ <imageobject> <imagedata fileref="images/role/create_user.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Creating a user in the User management portlet. + </para> + </caption> </mediaobject> </para> </sect3> @@ -93,29 +130,43 @@ to approve or reject all selected users. </para> <para> + <mediaobject> <imageobject> <imagedata fileref="images/role/user_pending.png" format="png" align="center" valign="middle"/> - <caption>Normal state</caption> </imageobject> + <caption> + <para> + Approve or reject pending registrations. + </para> + </caption> + </mediaobject> </para> + <note> + By default the subscription modes are set to <emphasis>automatic</emphasis> and users will be created automatically. Furthermore the + link to <emphasis>Show pending registrations</emphasis> will only be displayed if a user needs to be approved by the administrator. + </note> </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> + The User management portlet is also responsible to create and edit roles and it is accessible once logged in - as described in previously - when clicking on the <emphasis>role management</emphasis> link in the User management portlet. </para> <sect2> <title>Introduction</title> - <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> A role will be used to grant different permission levels to different portlets, pages, or portal instances. A user can have several roles. </para> <para> <imageobject> <imagedata fileref="images/role/role_management.png" format="png" align="center" valign="middle"/> - <caption>Normal state</caption> </imageobject> + <caption> + <para> + Role management. + </para> + </caption> </para> </sect2> <sect2> @@ -133,6 +184,11 @@ <imageobject> <imagedata fileref="images/role/create_role.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Create a new role. + </para> + </caption> </mediaobject> To create a new role, you need to define a short name that will be used for reference, and a display name for displaying to the user, for example @@ -146,25 +202,35 @@ <sect3 id="editrole"> <title>Edit a role</title> <para> - Editting roles, is accomplished by clicking on <emphasis>Edit role</emphasis> in the row of the role you want to edit. + Editing 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/edit_role.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Edit an existing role. + </para> + </caption> </mediaobject> - While editing a role, you just need to pick an exising role then change the display name. + While editing a role, you just need to pick an existing role then change the display name. </para> </sect3> <sect3 id="editrolemembers"> <title>Editing Role Members</title> <para> - Editting role members, is accomplished by first clicking the + Editing role members, is accomplished by first clicking the <emphasis>Members</emphasis> link at the role management page for the role you would like to modify. <mediaobject> <imageobject> <imagedata fileref="images/role/role_members.png" format="png" align="center" valign="middle"/> </imageobject> + <caption> + <para> + Show the members of an existing role. + </para> + </caption> </mediaobject> Allows for an administrator to search and modify the members' assigned roles. </para>