Author: channa Date: Sat Jul 19 03:12:19 2008 New Revision: 19628 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19628
Log: Updated user management documentation, including 'grant admin' and updating screenshots with new pages for OpenID and captcha, password changing. Added: trunk/mashup/java/xdocs/images/assign_admin.png (contents, props changed) trunk/mashup/java/xdocs/images/grant_admin_priv.png (contents, props changed) Modified: trunk/mashup/java/xdocs/images/Manage_Users.png trunk/mashup/java/xdocs/images/Self_Registration.png trunk/mashup/java/xdocs/images/User_Profile.png trunk/mashup/java/xdocs/images/self_reg_on.png trunk/mashup/java/xdocs/usermanagement.html Modified: trunk/mashup/java/xdocs/images/Manage_Users.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/Manage_Users.png?rev=19628&r1=19627&r2=19628&view=diff ============================================================================== Binary files. No diff available. Modified: trunk/mashup/java/xdocs/images/Self_Registration.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/Self_Registration.png?rev=19628&r1=19627&r2=19628&view=diff ============================================================================== Binary files. No diff available. Modified: trunk/mashup/java/xdocs/images/User_Profile.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/User_Profile.png?rev=19628&r1=19627&r2=19628&view=diff ============================================================================== Binary files. No diff available. Added: trunk/mashup/java/xdocs/images/assign_admin.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/assign_admin.png?pathrev=19628 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/grant_admin_priv.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/grant_admin_priv.png?pathrev=19628 ============================================================================== Binary file. No diff available. Modified: trunk/mashup/java/xdocs/images/self_reg_on.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/self_reg_on.png?rev=19628&r1=19627&r2=19628&view=diff ============================================================================== Binary files. No diff available. Modified: trunk/mashup/java/xdocs/usermanagement.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/usermanagement.html?rev=19628&r1=19627&r2=19628&view=diff ============================================================================== --- trunk/mashup/java/xdocs/usermanagement.html (original) +++ trunk/mashup/java/xdocs/usermanagement.html Sat Jul 19 03:12:19 2008 @@ -1,190 +1,248 @@ -<!-- - ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) - ~ - ~ Licensed under the Apache License, Version 2.0 (the "License"); - ~ you may not use this file except in compliance with the License. - ~ You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> -<html> -<head> - <meta http-equiv="content-type" content=""> - <title>User Management</title> - <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> -</head> -<body> -<div id="main-content"> -<h1>User Management<br> -</h1> -This document introduces the user management features of the WSO2 -Mashup Server: -<h2><br> -</h2> -<h1>Administrator Actions</h1> -The first part of this document describes the user management functions -that must be performed by an administrative user. Please refer to the -'User Actions' section below, for <br> -management options that do not require admin privileges.<br> -<br> -<h2>Setting Up The First User<br> -</h2> -<h3>Using the Browser<br> -</h3> -On starting up the server and accessing the website on localhost, the -provisioning page is displayed. This is where the primary or -administrative user should be created.<br> -<br> -<img style="width: 1008px; height: 557px;" alt="Provisioning Screen" - src="images/provisioning.png" href="images%5Cprovisioning.png"> <br> -<br> -The user name password and confirmation password fields are mandatory, -but you are also strongly advised to enter a valid e-mail ID as -password recovery is not possible <br> -without this. You may of course, -update this information later on, with user profile management features -described below.<br> -<br> -Keeping the 'Sign me in now' checkbox clicked will log you in -automatically, immediately after creating your administrator profile.<br> -<h3>Using a Configuration File</h3> -When a Browser is not available on the local system, you can use the -following parameters in the server.xml file of the mashup server, to -perform the administrator account creation.<br> -<ul> - <li>Change the 'CreatePrimary' parameter to 'true'</li> - <li>Specify the administrator account and password using the -PrimaryUser and PrimaryPassword parameters.<br> - </li> -</ul> - <PrimaryUserConfig><br> - <!--Set CreatePrimary to -'true' to activate option--><br> - -<CreatePrimary>true</CreatePrimary><br> - -<PrimaryUser>admin</PrimaryUser><br> - -<PrimaryPassword>admin</PrimaryPassword><br> - </PrimaryUserConfig><br> -<br> -<h2>Setting Up Self Registration</h2> -<br> -The primary or administrative user can enable self resigtration of -guests by clicking on the 'Allow Internet Guests' link in the -'Administrative tasks' pane.<br> -<img style="width: 260px; height: 137px;" alt="Admin tasks pane" - src="images/admin_tasks.png"><br> -<br> -You will be shown a page which confirms that self registration has been -enabled. This page will also provide details on the configuration -parameters to be completed in the <br> -web.xml page, to complete the self -registration setup.<br> -<br> -<img style="width: 1010px; height: 610px;" alt="Self registration on" - src="images/self_reg_on.png"><br> -<br> -Note that the link in the administrative tasks pane is a toggle and -will now display the link to 'Disallow Internet Guests'.<br> -<br> -<h2>Managing Users<br> -</h2> -<br> -All user management functions require admin privileges and are provided -from the 'Manage Users' page.<br> -<br> -<img style="width: 997px; height: 403px;" alt="Manage Users" - src="images/Manage_Users.png"><br> -<h3>Add User</h3> -Users can be added via the 'Add User' link in the administrative tasks -pane in addition to the link in the 'Manage Users' page.<br> -<br> -The page displayed will allow you to create a user with privileges to -create or modify their own mashups, comment on or rate other peoples -mashups and perform other basic <br> -user functions.<br> -<br> -<img style="width: 1003px; height: 568px;" alt="Add User" - src="images/Add_User.png"><br> -<br> -<ul> -</ul> -<h3>Edit User</h3> -The 'Edit User' image link displays the bage below, where an -administrator can change a registered users profile including the -password. Please note that if password modification <br> -is not required, the 'password' field should be allowed to remain empty.<br> -<br> -<img style="width: 1002px; height: 561px;" alt="Edit User" - src="images/Edit_User.png"><br> -<h3>Delete User</h3> -The 'Delete User' image link displays the page below. If the 'Purge -User Data' checkbox is not clicked, the delete button will simply -disable the user's login. Disabled users will be <br> -highlighted in the 'Manage Users' page and clicking on this 'Reactivate -User' icon will re-enable the user to login.<br> -<br> -<img style="width: 81px; height: 31px;" alt="Deleted_User" - src="images/deleted_user_icon.png"><br> -<br> -If the <span style="font-weight: bold;">'Purge User Data'</span> -checkbox is selected on deletion, the user's <span - style="font-weight: bold;">mashups</span> and <span - style="font-weight: bold;">comments </span>will be deleted along with -the user profile. <span style="font-weight: bold;">Please note that -this action <br> -is not reversible.</span><br> -<br> -<img style="width: 1004px; height: 564px;" alt="Delete User" - src="images/Delete_User.png"><br> -<br> -<h1>User Actions</h1> -<h2>Self Registration</h2> -Once the administrator has enabled the registration of internet guests, -a user can register himself or herself with a simple e-mail -verification. The 'Sign up' link on the page <br> -header takes a guest to the page below, which allows a new user to -enter a valid user ID, full name, e-mail ID and password and request -registration. Alternatively, an <br> -infocard can be used to furnish the name and e-mail ID, simplifying the -registration process.<br> -<br> -When this information is submitted, the user is requested to complete -the registration process by clicking on a verfication link sent to the -specified e-mail ID.<br> -<br> -<img style="width: 1001px; height: 558px;" alt="Self Registration" - src="images/Self_Registration.png"><br> -<br> -<h2>Forgotten Password</h2> -If a user requres a password reset, the 'Forgot Password?' link on the -'Sign-in' page will take him or her to the 'Reset Password' page, where -they can furnish their user <br> -and e-mail ID combination and request a new password. An automatically -generated password will be e-mailed to them.<br> -<br> -<img style="width: 1010px; height: 564px;" alt="Reset Password" - src="images/Reset_Password.png"><br> -<br> -<h2>Profile Management</h2> -<br> -The 'Profile' page can be accessed by clicking on the profile link in -the home page or the user name on the 'Signed in as ...' tab. Here a -user can change their personal <br> -information and associate an Infocard with their user ID using the -'Register your Infocard' link.<br> -<br> -<img style="width: 1002px; height: 768px;" alt="Profile" - src="images/User_Profile.png"><br> -<br> -</div> -<p>© WSO2 Inc.</p> -</body> -</html> +<!-- +~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) +~ +~ Licensed under the Apache License, Version 2.0 (the "License"); +~ you may not use this file except in compliance with the License. +~ You may obtain a copy of the License at +~ +~ http://www.apache.org/licenses/LICENSE-2.0 +~ +~ Unless required by applicable law or agreed to in writing, software +~ distributed under the License is distributed on an "AS IS" BASIS, +~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~ See the License for the specific language governing permissions and +~ limitations under the License. +--> +<html> +<head> + <meta http-equiv="content-type" content=""> + <title>User Management</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> +</head> + +<body> + +<div id="main-content"> +<h1>User Management<br> +</h1> + +<p>This document introduces the user management features of the WSO2 Mashup +Server: </p> + +<h2><br> +</h2> + +<h1>Administrator Actions</h1> + +<p>The first part of this document describes the user management functions +that must be performed by an administrative user. Please refer to the 'User +Actions' section below, for <br> +management options that do not require admin privileges.<br> +<br> +</p> + +<h2>Setting Up The First User<br> +</h2> + +<h3>Using the Browser<br> +</h3> + +<p>On starting up the server and accessing the website on localhost, the +provisioning page is displayed. This is where the primary or administrative +user should be created.<br> +<br> +<img style="width: 1008px; height: 557px;" alt="Provisioning Screen" +src="images/provisioning.png" href="images%5Cprovisioning.png"> <br> +<br> +The user name password and confirmation password fields are mandatory, but +you are also strongly advised to enter a valid e-mail ID as password recovery +is not possible <br> +without this. You may of course, update this information later on, with user +profile management features described below.<br> +<br> +Keeping the 'Sign me in now' checkbox clicked will log you in automatically, +immediately after creating your administrator profile.<br> +</p> + +<h3>Using a Configuration File</h3> + +<p>When a Browser is not available on the local system, you can use the +following parameters in the server.xml file of the mashup server, to perform +the administrator account creation.<br> +</p> +<ul> + <li>Change the 'CreatePrimary' parameter to 'true'</li> + <li>Specify the administrator account and password using the PrimaryUser + and PrimaryPassword parameters.<br> + </li> +</ul> + +<p>    <PrimaryUserConfig><br> +        <!--Set CreatePrimary to 'true' to +activate option--><br> +        +<CreatePrimary>true</CreatePrimary><br> +        +<PrimaryUser>admin</PrimaryUser><br> +        +<PrimaryPassword>admin</PrimaryPassword><br> +    </PrimaryUserConfig><br> +<br> +</p> + +<h2>Setting Up Self Registration</h2> + +<p><br> +The primary or administrative user can enable self resigtration of guests by +clicking on the 'Allow Internet Guests' link in the 'Administrative tasks' +pane.<br> +<img style="width: 260px; height: 137px;" alt="Admin tasks pane" +src="images/admin_tasks.png"><br> +<br> +You will be shown a page which confirms that self registration has been +enabled. This page will also provide details on the configuration parameters +to be completed in the <br> +web.xml page, to complete the self registration setup.<br> +<br> +<img style="width: 1010px; height: 610px;" alt="Self registration on" +src="images/self_reg_on.png"><br> +<br> +Note that the link in the administrative tasks pane is a toggle and will now +display the link to 'Disallow Internet Guests'.<br> +<br> +</p> + +<h2>Managing Users<br> +</h2> + +<p><br> +All user management functions require admin privileges and are provided from +the 'Manage Users' page.<br> +<br> +<img style="width: 997px; height: 403px;" alt="Manage Users" +src="images/Manage_Users.png"><br> +</p> + +<h3>Add User</h3> + +<p>Users can be added via the 'Add User' link in the administrative tasks +pane in addition to the link in the 'Manage Users' page.<br> +<br> +The page displayed will allow you to create a user with privileges to create +or modify their own mashups, comment on or rate other peoples mashups and +perform other basic <br> +user functions.<br> +<br> +<img style="width: 1003px; height: 568px;" alt="Add User" +src="images/Add_User.png"><br> +<br> +</p> +<ul> +</ul> + +<h3>Edit User</h3> + +<p>The 'Edit User' image link displays the bage below, where an administrator +can change a registered users profile including the password. Please note +that if password modification <br> +is not required, the 'password' field should be allowed to remain empty.<br> +<br> +<img style="width: 1002px; height: 561px;" alt="Edit User" +src="images/Edit_User.png"><br> +</p> + +<h3>Delete User</h3> + +<p>The 'Delete User' image link displays the page below. If the 'Purge User +Data' checkbox is not clicked, the delete button will simply disable the +user's login. Disabled users will be <br> +highlighted in the 'Manage Users' page and clicking on this 'Reactivate User' +icon will re-enable the user to login.<br> +<br> +<img style="width: 81px; height: 31px;" alt="Deleted_User" +src="images/deleted_user_icon.png"><br> +<br> +If the <span style="font-weight: bold;">'Purge User Data'</span> checkbox is +selected on deletion, the user's <span +style="font-weight: bold;">mashups</span> and <span +style="font-weight: bold;">comments </span>will be deleted along with the +user profile. <span style="font-weight: bold;">Please note that this action +<br> +is not reversible.</span><br> +<br> +<img style="width: 1004px; height: 564px;" alt="Delete User" +src="images/Delete_User.png"> </p> + +<p></p> + +<h3>Assign Administrative Privileges</h3> +<img alt="Assign Admin Icon" src="images/assign_admin.png"> +<p>The primary user is permitted to assign administrative privileges to any +other registered user. Clicking the 'Assign Admin' icon will display a +confirmation page, where the 'Grant' button will grant these privileges <br/> +to the selected user and toggle icon in the 'Manage Users' page to call +the 'Revoke Admin' action.</p> + +<p></p> + +<p><img alt="Assign Admin Confirmation Page" +src="images/grant_admin_priv.png"></p> + +<h1>User Actions</h1> + +<h2>Self Registration</h2> + +<p>Once the administrator has enabled the registration of internet guests, a +user can register himself or herself with a simple e-mail verification. The +'Sign up' link on the page <br> +header takes a guest to the page below, which allows a new user to enter a +valid user ID, full name, e-mail ID and password and request registration. +Alternatively, an <br> +InfoCard or OpenID, described in the Identity page, can be used to furnish +user details, simplifying the registration process.<br> +<br> +When this information is submitted, the user is requested to complete the +registration process by clicking on a verfication link sent to the specified +e-mail ID.<br> +<br> +<img style="width: 1001px; height: 558px;" alt="Self Registration" +src="images/Self_Registration.png"><br> +<br> +</p> + +<h2>Forgotten Password</h2> + +<p>If a user requres a password reset, the 'Forgot Password?' link on the +'Sign-in' page will take him or her to the 'Reset Password' page, where they +can furnish their user <br> +and e-mail ID combination and request a new password. An automatically +generated password will be e-mailed to them.<br> +<br> +<img style="width: 1010px; height: 564px;" alt="Reset Password" +src="images/Reset_Password.png"><br> +<br> +</p> + +<h2>Profile Management</h2> + +<p><br> +The 'Profile' page can be accessed by clicking on the profile link in the +home page or the user name on the 'Signed in as ...' tab. Here a user can +change personal information such as their display name, e-mail ID, bio or <br> +password. They can also associate an InfoCard or OpenID with their user +profile using the 'Register your Infocard' or 'Register your OpenID' +links.</p> + +<p>Further details on managing OpenID and InfoCard are provided in the +Identity page.<br> +<br> +<img style="width: 1010px; height: 564px;" alt="Profile" +src="images/User_Profile.png"><br> +<br> +</p> +</div> + +<p>© WSO2 Inc.</p> +</body> +</html> _______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
