[wsas-java-dev] svn commit r514 - wsas/java/trunk/xdocs
svn at wso2.com
svn at wso2.com
Sun Jan 21 22:32:58 PST 2007
Author: marietta
Date: Sun Jan 21 22:32:38 2007
New Revision: 514
Modified:
wsas/java/trunk/xdocs/administratorguide.html
Log:
Reviewed and made minor changes.
Modified: wsas/java/trunk/xdocs/administratorguide.html
==============================================================================
--- wsas/java/trunk/xdocs/administratorguide.html (original)
+++ wsas/java/trunk/xdocs/administratorguide.html Sun Jan 21 22:32:38 2007
@@ -13,8 +13,8 @@
<h1>WSO2 Web Services Application Server (WSO2 WSAS) for Java,
v at wso2wsas_version@- Administrator's Guide</h1>
-<p>This document will provide you with information & instructions on the
-functionality of Management Console of WSO2 WSAS for Java .</p>
+<p>This document provides information and instructions on the functionality
+of the Management Console of WSO2 WSAS for Java .</p>
<p>Your feedback on WSO2 WSAS for Java is most appreciated. Please send them
to our <a href="index.html#mail">mailing lists</a>.</p>
@@ -76,7 +76,7 @@
<p>WSO2 WSAS is a lightweight, high performant and integrated Web services
middleware platform.</p>
-<p>To learn more about WSO2 WSAS see <a href="index.html">here.</a></p>
+<p>To learn more about WSO2 WSAS click <a href="index.html">here.</a></p>
<p>WSO2 WSAS Management Console is your one stop shop to administer the WSO2
Web Services Application Server. You can administer/configure your
@@ -85,35 +85,36 @@
<p>WSO2 WSAS for Java Management Console runs on <a
href="http://en.wikipedia.org/wiki/Ajax_(programming)">AJAX</a> (Asynchronous
Javascript and XML) and SOAP, making it a fast administration tool. All the
-functionality is provided by a set of web services exposed by the WSO2
+functionalities are provided by a set of web services exposed by the WSO2
WSAS.</p>
-<p>Before going through the functionality, we recommend you read the <a
+<p>Before going through the functionality, we recommend that you read the <a
href="#browser_settings">Web Browser Specific Settings</a> section to ensure
-you have access to full list of features WSO2 WSAS AJAX Management console
-have to offer through your Web browser.</p>
+that you have access to the full list of features WSO2 WSAS AJAX Management
+console offers through your Web browser.</p>
-<p>The functionality of this Management Console is described in detail
+<p>The functionality of the Management Console is described in detail
below.</p>
<a id="signin"></a>
<h2>Signing In</h2>
-<p>Once WSO2 WSAS for Java, v at wso2wsas_version@ is successfully installed
-(See <a href="installationguide.html">Installation Guide</a> for installation
-details), start the WSO2 WSAS server, launch a Web browser instance and point
-it to the URL <a href="https://localhost:9443/">https://localhost:9443/</a>
-(for the Standalone Edition) or <a
+<p>Once WSO2 WSAS for Java, v at wso2wsas_version@ has been successfully
+installed (See <a href="installationguide.html">Installation Guide</a> for
+installation details), start the WSO2 WSAS server, launch a Web browser
+instance and point it to the URL <a
+href="https://localhost:9443/">https://localhost:9443/</a> (for the
+Standalone Edition) or <a
href="https://localhost:9443/">https://localhost:9443/wso2wsas/</a> (for the
Servlet Edition) if you are using the default settings. This will take you to
-the "Sign In" page of WSO2 WSAS Management Console as shown below.</p>
+the "Sign In" page of the WSO2 WSAS Management Console as shown below.</p>
<p><strong>Note</strong>: WSO2 WSAS has two transport listeners: HTTP and
-HTTPS. The HTTP listener opens on port 9762, while the HTTPS listener opens
-on port 9443, by default. The admin functionality is exposed only via the
-HTTPS port.</p>
+HTTPS. By default, the HTTP listener opens on port 9762, while the HTTPS
+listener opens on port 9443. The administrator functionality is exposed only
+via the HTTPS port.</p>
-<p>You can now read all WSO2 WSAS for Java <strong>documents</strong> by
+<p>You can now read all the WSO2 WSAS for Java <strong>documents</strong> by
pointing your Web browser to <a
href="https://localhost:9443/docs">https://localhost:9443/docs</a> (for the
Standalone Edition) or <a
@@ -132,13 +133,13 @@
<p><strong>Password :</strong> admin</p>
-<p>To solve any problems with signing in click on <!--<a
+<p>To solve any problems with signing in, click <!--<a
href="../sign_in_help.html">-->
- "sign-in Help"</p>
+ "Sign-in Help"</p>
<p>The Sign In page contains links to the <!--<a href="../faq.html">-->
"FAQ" and the <!--<a href="../about.html">-->
- "about WSO2 WSAS" page which gives an introduction about WSO2 WSAS and WSO2
+ "About WSO2 WSAS" page which gives an introduction about WSO2 WSAS and WSO2
Inc.</p>
<a id="nav_bar"></a>
@@ -171,34 +172,34 @@
<h2>Home</h2>
-<p>Home Page of the Management Console will contain following useful
+<p>The Home Page of the Management Console will contain the following useful
<strong>system and service information on WSO2 WSAS.</strong></p>
<ul>
<li><strong>System Summary</strong>
<ul>
- <li>Free Memory- Free memory of JVM</li>
- <li>Request Count - The number of requests that have gone through the
- server (this includes requests to the admin service which will
- explain the small number you see here)</li>
+ <!--<li>Free Memory- Free memory of JVM</li>-->
+ <!--<li>Request Count - The number of requests that have gone through the
+ server (this includes requests to the admin service, which will
+ explain the small number you see here</li>-->
<li>Server Name - The name of the server</li>
<li>Server Version - The version of the above named server</li>
<li>Server Start Time- The time the server was started/restarted</li>
<li>System Up Time - The time span for which the server has been
running</li>
- <li>Memory Allocated - Total JVM memory allocated for this server</li>
+ <li>Memory Allocated - Total JVM memory allocated for the server</li>
<li>Memory Usage - Total JVM memory used by the server</li>
</ul>
</li>
<li><strong>Service Summary</strong>
<ul>
- <li>Total Request Count - Will list the number of requests since the
- server started</li>
- <li>Total Response Count - Will list the number of requests since the
+ <li>Total Request Count - Lists the number of requests since the server
+ started</li>
+ <li>Total Response Count - Lists the number of requests since the
server started</li>
- <li>Total Fault Count - Will list the number of faults that occurred
- since the server started</li>
- <li>Active Services - Will list how many services are deployed and
- running in the server</li>
+ <li>Total Fault Count - Lists the number of faults that occurred since
+ the server started</li>
+ <li>Active Services - Lists how many services are deployed and running
+ on the server</li>
</ul>
</li>
</ul>
@@ -233,48 +234,46 @@
<p><strong>Figure: Services and Service Group Management</strong></p>
-<p>As shown above, this page will list each of the <strong>services
-available, rather deployed in each service group</strong> of this system
-along with links to view WSDL both 1.1, Schema, Policy and Certificate
-(containing public key if the service has been signed using a private key) of
-each service.</p>
+<p>As shown above, this page lists the available services or those deployed
+in each service group in the system, along with links to view the WSDL1.1,
+Schema, Policy and Certificate (containing the public key if the service has
+been signed using a private key) of each service.</p>
-<p>This page also carries a link that displays <a href="#rss">RSS</a> an <a
+<p>This page also carries a link that displays <a href="#rss">RSS</a> and <a
href="#atom">Atom</a> feeds.</p>
<p><img alt="Figure:View WSDL 1.1 of service echo" src="images/wsdl1.1.jpg"
/><br />
</p>
-<a id="remove_group"><strong>Figure: View WSDL 1.1 of Service
-echo</strong></a>
+<a id="remove_group"><strong>Figure: WSDL 1.1 of Service echo</strong></a>
<h3>Remove Service Group:</h3>
<p><strong>A service group can be removed</strong> using the 'Remove' action
icon listed for each service group, in which case all the services in that
-particular service archive will be removed from system.</p>
+particular service archive will be removed from the system.</p>
<a id="deploy_services"></a>
<h3>Deploying Services:</h3>
<strong>Upload a New Service (.aar, .jar or .zip)</strong>
<p>The most important feature of this page is the ability to deploy and
-manage services. In the case where the <strong>service archive of the
-relevant service is an .aar</strong> you can deploy the service by simply
-selecting the service archive using 'Browse' button, then uploading service
-using the 'Upload' button. For example, Axis2 packages services as .aar
-files. You can simply deploy an Axis2 service by uploading the relevant .aar
+manage services. If the <strong>service archive of the relevant service is an
+.aar</strong>, you can deploy the service by simply selecting the service
+archive by clicking 'Browse', and then uploading the service by clicking
+'Upload'. For example, Axis2 packages the services as .aar files. Therefore,
+you can simply deploy an Axis2 service by uploading the relevant .aar
file.</p>
<p>Where the <strong>service archive of the relevant service is a .jar or
-.zip file</strong> then deployment requires a few more steps. In this case
-you must select the service archive using 'Browse' button, then upload
-service using the 'Upload' button, where in doing so a page containing the
-classes of the archive will appear as shown below. Here you need to select
-the relevant classes of the web services you wish to deploy, by clicking on
-the corresponding check boxes. Once you have selected all the classes, click
-on 'Generate' button to deploy the relevant services. This process is called
-<strong>Dynamic Service Generation.</strong></p>
+.zip file</strong>, then the deployment requires a few more steps. In this
+case, you must select the service archive by clicking 'Browse', and then
+upload the service by clicking 'Upload'. Then, a page containing the classes
+of the archive will appear as shown below. On this page, select the relevant
+classes of the web services you wish to deploy by selecting the corresponding
+check boxes. Once you have selected all the classes, click 'Generate' to
+deploy the relevant services. This process is called <strong>Dynamic Service
+Generation.</strong></p>
<p><img alt="Figure: Dynamic Services Generation-Uploading .jar or .zip File"
src="images/dynamic_services.jpg" /><br />
@@ -284,9 +283,10 @@
File</strong></p>
<strong>Upload a New Spring Service (.xml and .jar)</strong>
-<p>Likewise you can also deploy Spring services by browsing for and uploading
-relevant .xml and .jar files. Deploying Spring services follow the
-<strong>Dynamic Service Generation</strong> procedure as explained before.</p>
+<p>Likewise, you can also deploy Spring services by browsing for and
+uploading the relevant .xml and .jar files. Deploying Spring services follows
+the <strong>Dynamic Service Generation</strong> procedure as explained
+above.</p>
<p><img
alt="Figure: Dynamic Service Generation for Spring Service-Uploading.xml or .jar File"
@@ -295,17 +295,17 @@
<p><strong>Figure: Dynamic Service Generation for Spring Service-Uploading
.xml or .jar File</strong></p>
-<p>If services were successfully deployed, then a message will appear saying
-so. The service that you deployed will now be listed on the main page of '<a
-href="#services">Manage Services</a>' (as shown in Figure: Services and
-Service Group Management).</p>
+<p>If the services were successfully deployed, then a message will appear
+saying so. The service that you deployed will now be listed on the main page
+of <a href="#services">'Manage Services</a>' (as shown in Figure: Services
+and Service Group Management).</p>
<a id="rss"></a>
<h3>RSS Feed:</h3>
-<p>RSS feed gives the subscriber updates about any status changes in services
-in WSO2 WSAS. These include activation, de-activation, removal, etc. of the
-services. The RSS standard that is used is 2.0.</p>
+<p>RSS feed gives the subscriber updates about any status changes in the
+services in WSO2 WSAS. These include activation, de-activation, removal, etc.
+of the services. The RSS standard used is 2.0.</p>
<p><img alt="Figure:RSS Feed Page" src="images/rss.jpg" /><br />
</p>
@@ -313,9 +313,9 @@
<h3>Atom Feed:</h3>
-<p>Atom feed gives the subscriber updates about any status changes in
+<p>Atom feed gives the subscriber updates about any status changes in the
services in WSO2 WSAS. These include activation, de-activation, removal, etc.
-of the services. The Atom standard that is used is 2.0.</p>
+of the services. The Atom standard used is 2.0.</p>
<p><img src="images/atom.jpg " /><br />
</p>
@@ -325,15 +325,15 @@
<h3>Deleting Faulty Services:</h3>
-<p>If a <strong>faulty service</strong> is deployed it will be displayed in
-this Available Services page as <span
+<p>If a <strong>faulty service</strong> is deployed, it will be displayed on
+the Available Services page as <span
style="font-style: italic; font-weight: bold;">[n] faulty
service(s)</span>:</p>
-<p>Click on the faulty service link and it will take you to a page as shown
-below where details of the faulty service(s) will be listed. By using the
-'Delete Faulty Service' icon on this page you will be able to delete the
-deployed faulty service.</p>
+<p>Clicking on the faulty service link willl open the page as shown below, on
+which the details of the faulty services will be listed. By using the 'Delete
+Faulty Service' icon on this page, you will be able to delete the deployed
+faulty service.</p>
<p><img alt="Figure: Deleting Faulty Services"
src="images/delete_service.jpg" /><br />
@@ -344,15 +344,15 @@
<h3>Service Group Management:</h3>
-<p>Clicking on the Service Group in of the main page of "<a
+<p>Clicking on the Service Group on the main page of "<a
href="#services">Manage Services</a>" (as shown in Figure:Services and
-Service Group Management) will take you to a page that allows you to:</p>
+Service Group Management), will open a page on which you can:</p>
<ul>
- <li><strong>Manage Service Group Parameters</strong>: service group
+ <li><strong>Manage Service Group Parameters</strong>: Service group
parameters can be edited here</li>
- <li><strong>Manage Module Engagements</strong>: will list modules engaged
- at service group Level and on a global level. You can also engage or
- disengage modules to the specific service group here</li>
+ <li><strong>Manage Module Engagements</strong>: Lists the modules engaged
+ at the service group level and on a global level. You can also engage or
+ disengage modules to the specific service group.</li>
</ul>
<p><img src="images/servicegroup_engagemodule.jpg"
@@ -363,60 +363,60 @@
<h3>Service Management:</h3>
-<p>Clicking on the Service of a specific Service Group of the main page of
+<p>Clicking on the service of a specific service group on the main page of
"<a href="#services">Mange Services</a>" (as shown in Figure:Services and
-Service Group Management) will take you to a page that not only contains
-certain <strong>service specific information</strong>, but also allows you to
-<strong>manage services</strong>.</p>
+Service Group Management), will open a page that contains certain
+<strong>service specific information</strong>, and also allows you to
+<strong>manage the services</strong>.</p>
<p><img alt="Figure: Service Management" src="images/service_mgt.jpg" /><br />
</p>
<p><strong>Figure: Service Management Page</strong></p>
-<p>Service <strong>information</strong> will consist of:</p>
+<p>Service <strong>information</strong> consists of:</p>
<ul>
<li>Service name and description</li>
<li>Service status - It will display whether the service is active or
inactive. You also have the option of changing the service status using
the 'Activate'/ 'Inactivate' button.</li>
<li>Request count - The number of times the service has been called</li>
- <li>Response count -The number of response SOAP messages</li>
+ <li>Response count -The number of SOAP message responses</li>
<li>Fault count - The number of times a fault has been encountered</li>
<li>Max Response Time</li>
<li>Min Response Time</li>
<li>Avg Response Time</li>
<li>End Point References - All the EPRs of the service will be listed here.
- The client can use any URL of it's choice.</li>
+ The client can use any URL of its choice.</li>
</ul>
-<p>The <strong>service management</strong>options that are available are as
+<p>The <strong>service management</strong> options that are available are as
follows:</p>
<ul>
- <li><strong>Manage Service Operations</strong> - This links to a page that
+ <li><strong>Manage Service Operations</strong> - This opens the page that
lists the <strong>published operations</strong> of the service, with the
- options of editing operation specific parameters, viewing engaged modules
- and Axis2 handlers.
+ options of editing operation specific parameters, and viewing engaged
+ modules and Axis2 handlers.
<p><img alt="Figure:Published Operations Page" src="images/operation.jpg"
/><br />
</p>
<p><strong>Figure: Published Operations Page</strong></p>
- <p>Click on a specific operation link and that will take you to a page
- with <strong>operations statistics</strong> and <strong>operation
+ <p>Click on a specific operation link to open the page that displays the
+ <strong>operations statistics</strong> and <strong>operation
parameters</strong>.</p>
<p><img alt="Figure:Figure: Operation Statistics and Parameters"
src="images/operation_infor.jpg" /><br />
</p>
<p><strong>Figure: Operation Statistics and Parameters</strong></p>
- <p>Click on '<strong>Edit operation specific parameter</strong>' icon of
- a relevant service in "Figure: Published Operations Page", and it will
- take you to a page with operations editable (declared) parameters with
- the ability to you to add or update parameters. When the operation does
- not have editable parameters the page will display the message "No
- editable parameters present". When adding a new parameter use 'Add'
- button after which you will be prompted for a parameter name and value.
- By changing parameter value in text box and clicking on 'Update' button
- will change the parameter value.</p>
+ <p>Click on the '<strong>Edit operation specific parameter</strong>' icon
+ of a relevant service on the 'Published Operations Page". This will open
+ a page with the opration's editable (declared) parameters. You can add or
+ update the parameters on this page. When the operation does not have
+ editable parameters, the message "No editable parameters present" will be
+ displayed.</p>
+ <p>To add a new parameter, click 'Add'. You will be prompted for a
+ parameter name and value. To change a parameter value, change the
+ parameter value in the text box and click 'Update'.</p>
<p><img alt="Figure: Edit Operation Parameter"
src="images/operation_param.jpg" /><br />
</p>
@@ -424,39 +424,39 @@
<p><strong>Figure: Edit Operation Parameter</strong></p>
- <p>'<strong>View Engaged Modules</strong>' icon for each operation shown in
- "Figure: Published Operations Page" will lead to a page with;</p>
+ <p>The '<strong>View Engaged Modules</strong>' icon for each operation
+ shown in "Figure: Published Operations Page" opens a page with,</p>
<ul>
- <li>list of engaged modules at operation level with the option of
- disengaging the module at operation level using the 'Disengage'
+ <li>a list of engaged modules at operation level with the option of
+ disengaging the module at operation level by using the 'Disengage'
icon.</li>
- <li>list box containing modules that can be engaged. Select a module from
- the list and click the 'Engage' button to engage the module at
- operation level.</li>
- <li>list of modules engaged at service level.</li>
- <li>list of globally engaged modules.</li>
+ <li>a list containing modules that can be engaged. Select a module from
+ the list and click 'Engage' to engage the module at operation
+ level.</li>
+ <li>a list of modules engaged at service level.</li>
+ <li>a list of globally engaged modules.</li>
</ul>
<p><img alt="Figure:Figure: Figure: Engaged Operation level Modules"
src="images/engage_module_operation.jpg" /><br />
</p>
- <p><strong>Figure: Engaged Operation level Modules</strong></p>
+ <p><strong>Figure: Engaged Operation Level Modules</strong></p>
- <p>"<strong>View Axis2 Handler</strong>" icon on "Figure: Published
- Operations Page" will take you to a page that displays the flow of Apache
- Axis2 handlers of this particular operation of the service.</p>
+ <p>The "<strong>View Axis2 Handler</strong>" icon on "Figure: Published
+ Operations Page" opens a page that displays the flow of the Apache Axis2
+ handlers of this particular operation of the service.</p>
<p><img alt="Figure:Operation level module" src="images/flow.jpg" /><br />
</p>
<p><strong>Figure: View Axis2 Handler</strong></p>
- <li><strong>Manage Module Engagements</strong>- Here modules engaged at
- service level, service group level and global level are listed. You have
- the option of engaging/disengaging modules on a service level from this
- page. Modules can be selected from a list box and engaged at service
- level using 'Engage' button. Using the "Disengage" icon of the relevant
- module you can easily disengage service level module.</li>
+ <li><strong>Manage Module Engagements</strong>- Here, the modules engaged
+ at service level, service group level and global level are listed. You
+ have the option of engaging/disengaging the modules on a service level
+ from this page. Modules can be selected from a list and engaged at
+ service level by clicking 'Engage'. By using the "Disengage" icon of the
+ relevant module, you can easily disengage a service level module.</li>
<p><img alt="Figure:Manage Service Level Module Engagements"
src="images/service_engagemodule.jpg" /><br />
@@ -471,43 +471,41 @@
</p>
<p><strong>Figure: Service Level Transport Configuration</strong></p>
- <li><strong>Manage Security Configuration</strong>- The security
- configuration scenarios available are listed here. Selecting the scenario
- you desire by clicking on the relevant radio button and clicking the
- "Continue" button you can activate the desired security configuration
- scenario for the service.</li>
+ <li><strong>Manage Security Configuration</strong>- The available security
+ configuration scenarios are listed here. Click the corresponding radio
+ button to select the scenario you want, and then click Continue. This
+ will activate the desired security configuration scenario for the
+ service.</li>
<p><img alt="Figure:Service Level Security Configurations"
src="images/security_config.jpg" /><br />
</p>
<p><strong>Figure: Service Level Security Configurations</strong></p>
- <li><strong>Edit Service Parameters</strong>- This link will lead to page
- with editable (declared) parameters and non-editable parameters. Declared
- parameters can be edited and updated using the 'Update' button in this
- page itself.</li>
+ <li><strong>Edit Service Parameters</strong>- This link opend a page with
+ editable (declared) parameters and non-editable parameters. Declared
+ parameters can be edited and updated by using the 'Update' button on this
+ page.</li>
<p><img alt="Figure:Edit Service Parameters"
src="images/edit_parameters.jpg" /><br />
</p>
<p><strong>Figure: Edit Service Parameters</strong></p>
- <li><strong>Edit Service Policies</strong> - This link will take you to a
- page that allows you to edit the policy of the Web service. You can save
- the changes made to the policy by clicking on the 'Update' button. If
- policies are available for the Web service you will see the following
- page.</li>
+ <li><strong>Edit Service Policies</strong> - This link opens a page on
+ which you can edit the policy of the Web service. You can save the
+ changes made to the policy by clicking 'Update'. If there are policies
+ available for the Web service, you will see the following page.</li>
<p><img alt="Figure:Edit Service Policies" src="images/edit_policy.jpg"
/><br />
</p>
<p><strong>Figure: Edit Service Policies</strong></p>
- <li><strong>Generate Client</strong> - This link leads to a page where you
- can generate stubs for the service after selecting the relevant values
- for databinding parameters - Package name, Invocation style, Generate
- test cases, Unpack classes & Databinding method, and then clicking on
- the 'Generate' button.</li>
+ <li><strong>Generate Client</strong> - This link opens a page where you can
+ generate stubs for the service. Select the relevant values for the
+ databinding parameters - Package name, Invocation style, Generate test
+ cases, Unpack classes and Databinding method. Then click 'Generate'.</li>
<p><img alt="Figure:Generate Service Client" src="images/stub.jpg" /><br />
</p>
@@ -523,22 +521,21 @@
<p><strong>Figure: Try Service - Operations Available</strong></p>
<li>Once the XHTML client has been generated, the user can work on a page
- as follows. It has two sections, the Upper section handles the requests
- and Lower section displays the response. Once the user hits the "Try"
- button, the script executes, and "Table Reset" button reset the request
- table. <!--<p><strong>Note</strong>: If you are using Mozilla Firefox 1.5.0 or above
- Web browser, and you are using a loop back address (127.0.0.1or
- localhost), while you are connected to a network, in other words, have
- your own machine IP, then you have to point you browser to your machine
- IP (for example, https://192.168.1.250:9443) and resign-in to WSAS
- management console before trying out the above "Try its". This is because
- of Firefox security restrictions on machines connected to a network. If
- you only have a machine IP none of these restrictions are applied and you
- can "Try it" without having to resign-in.</p>-->
+ as follows. It has two sections, the upper section handles the requests
+ and the lower section displays the response. Once the user clicks "Try",
+ the script executes. The "Table Reset" button resets the request table. <!--<p><strong>Note</strong>: If you are using Mozilla Firefox 1.5.0 or above
+ Web browser, and you are using a loop back address (127.0.0.1or
+ localhost), while you are connected to a network, in other words, have
+ your own machine IP, then you have to point you browser to your machine
+ IP (for example, https://192.168.1.250:9443) and resign-in to WSAS
+ management console before trying out the above "Try its". This is because
+ of Firefox security restrictions on machines connected to a network. If
+ you only have a machine IP none of these restrictions are applied and you
+ can "Try it" without having to resign-in.</p>-->
<p><strong>Note</strong>: The XTML client features are still at an
experimental stage. It has successfully been tested for simple types,
- simple arrays and complex types. But we still do not support complex
+ simple arrays and complex types. We still do not support complex
arrays.</p>
</li>
@@ -548,10 +545,10 @@
<p><strong>Figure: Try Service Operations</strong></p>
<li><strong>Application GUI</strong>- If a Web service invokes a Web based
- Application GUI, then this link will point your browser run the Web based
- client and point browser to application.</li>
+ Application GUI, then this link will point your browser to run the Web
+ based client application.</li>
- <p><img alt="Figure:Application GUI" src="images/gui_app.jpg" /><br />
+ <p><img alt="Figure:Application GUI" src="images/gui_app.jpg" /> <br />
</p>
</ul>
@@ -560,36 +557,36 @@
<h2>Manage Modules</h2>
-<p>On this page you can view all the modules available for engagement in the
-system. It will give name, version and description of the modules. Each
+<p>On this page, you can view all the modules available for engagement in the
+system. It will give the name, version and description of the modules. Each
module can be removed using the "Remove module" icon and can be globally
engaged/disengaged through the "Globally engage/disengage" icon.</p>
-<p>One a module is globally engaged it will be listed under the "Globally
+<p>Once a module is globally engaged, it will be listed under the "Globally
Engaged Modules" list.</p>
-<p>When you remove a module that module will be completely removed from the
-system. That is, the module handlers will be removed from the handler chain
-and the module mar file will be deleted. However if you disable a module then
-the module will be still in the system while the handlers from that module
-will be removed from the handler chain.</p>
-
-<p>You can upload a new module by using the 'Browse' button to browse for the
-.mar file (module archive) and upload using 'Upload' button. The uploaded
-module will be added to the topmost list of available modules with options to
-"Engage globally" or 'Remove module'.</p>
+<p>When you remove a module, that particular module will be completely
+removed from the system. That is, the module handlers will be removed from
+the handler chain and the module .mar file will be deleted. However, if you
+disable a module, then the module will still be in the system while the
+handlers from that module will be removed from the handler chain.</p>
+
+<p>To upload a new module, use the 'Browse' button to browse for the .mar
+file (module archive), and then click 'Upload'.. The uploaded module will be
+added to the topmost list of the available modules with the options "Engage
+globally" or 'Remove module'.</p>
<p><img alt="Figure:Globally Engage Modules" src="images/qos.jpg" /><br />
</p>
<p><strong>Figure: Globally Engage Modules</strong></p>
-<p>When you click on the module name it takes you to a page where
+<p>When you click on the module name, it takes you to a page where
<strong>module configuration</strong> is possible. Module configuration is
done through <a href="#module_param_config">parameter configuration</a> and
<a href="#module_policy_config">policy configuration</a>. The page also lists
-<strong>module information</strong> such as module ID, version, description
-and whether the fact that the module is globally engaged or not.</p>
+<strong>module information</strong> such as the module ID, version,
+description and whether the module is globally engaged.</p>
<p><img alt="Figure:Module Information and Configuration"
src="images/qos_module_info.jpg" /><br />
@@ -599,17 +596,17 @@
<a id="module_param_config"></a>
<p>When the <strong>Configure Parameters</strong> link is clicked, the page
-that appears will contain editable parameters allowing you to add or update
-parameters using 'Add' or 'Update' buttons.</p>
+that opens contains editable parameters. You can add or update the parameters
+using the 'Add' or 'Update' buttons.</p>
<p><img alt="Figure: Module Parameter Configuration"
src="images/module_configure.jpg" /></p>
<p><strong>Figure: Module Parameter Configuration</strong></p>
-<p>In the case where there are no editable parameters, page will say that
-there are no editable parameters found, with the option of adding a new
-parameter using the 'Add' button.</p>
+<p>In case there are no editable parameters, a message will appear on the
+page informing you that there are no editable parameters found. You will have
+the option of adding a new parameter using the 'Add' button.</p>
<p><img alt="Figure:Module Parameter Configuration- No Parameters Found"
src="images/module_configure_noparam.jpg" /><br />
@@ -620,10 +617,10 @@
<a id="module_policy_config"></a>
<p>Similarly, when the '<strong>Configure Policies</strong>' link in "Figure:
-Module Information and Configuration" is clicked you would obtain the
-following page where policies are present. You can edit in the text area
-itself and update any changes using the 'Update' button. If there are no
-policies for the module then page will read as "No module policies found."</p>
+Module Information and Configuration" is clicked, the page containing the
+policies will be opened (as displayed below). You can edit in the text area
+itself and update any changes by clicking 'Update'. If there are no policies
+for the module, then the page will read as "No module policies found."</p>
<p><img alt="Figure:Module Policy Configuration"
src="images/sandesha_policy.jpg" /><br />
@@ -634,16 +631,16 @@
<h2>Manage Security</h2>
-<p>This page will list areas of security management, currently User and Role
-management.</p>
+<p>This page lists areas of security management. Currently it contains User
+and Role management.</p>
<ol>
- <li><a href="#roles">Role Management</a> - Create new roles and edit
+ <li><a href="#roles">Role Management</a> - Creates new roles and edits
existing roles.</li>
- <li><a href="#users">User Management</a> - Create new users, assign roles
- to users and edit existing users.</li>
+ <li><a href="#users">User Management</a> - Creates new users, assigns roles
+ to users and edits existing users.</li>
<!--<li><a href="admin">Administrator Management</a> - Create new administrators,
- edit existing administrators who administer the WSO2 WSAS Management
- Console.</li>-->
+ edit existing administrators who administer the WSO2 WSAS Management
+ Console.</li>-->
</ol>
<p><img alt="Figure:Security Management Main Page" src="images/users.jpg"
@@ -655,10 +652,10 @@
<h3>Role Management:</h3>
-<p>Clicking on the Role Management link will take you to a page that consists
-of a list of existing role names with the option of adding new role names.
-This is done by typing in new role name and clicking on 'Add' button. If role
-was added successfully an alert message will pop up.</p>
+<p>Clicking on the Role Management link will open a page that consists of a
+list of existing role names, with the option of adding new role names. This
+is done by entering a new role name and clicking 'Add' . If a role was added
+successfully, a message (alert) will appear.</p>
<p>You can also delete a role by using the "Delete Role" icon.</p>
@@ -670,14 +667,14 @@
<h3>User Management:</h3>
-<p>User Management link will take you to a page with a <a
-href="#present_users">list of present users</a> with the option of adding in
-new users to this list. In order to add a new user, Username, Password &
-Confirm password (same as password) need to be typed in and user role
-selected from the list, then click on the 'Add' button. If the user was added
-successfully an alert message will pop up saying so.</p>
+<p>The User Management link opens a page with a <a href="#present_users">list
+of present users</a> with the option of adding new users to this list. In
+order to add a new user, the Username, Password and Confirm password (same as
+password) fields need to be filled. Select a user role from the list, and
+then click 'Add' . If the user was added successfully, a message (alert) will
+appear informing you that the user has been added successfully.</p>
-<p>Note that user role list contains all role names listed in <a
+<p>Note that the User Role list contains all the role names listed on the <a
href="#roles">Role Management page</a> from which new roles can be added as
well.</p>
@@ -687,18 +684,18 @@
<p><strong>Figure: User Management</strong></p>
<a id="present_users"></a>
-<p>The <strong>present users list</strong> comes with columns of "User Name",
-"user Description, "User Actions", "User Role" and "User Role Actions". User
-Actions contain "Edit" and "Delete User" icons.</p>
-
-<p>Clicking on "Edit" icon will take you to a page that allows you to edit
-corresponding user- change the role name of the user and reset password. Once
-new user role is selected from the list in order to update change click on
-'Update Role' button. If role has been successfully changed an alert message
-will pop up saying so. To reset the password, the new password & the
-confirmation of new password (same as new password) should be correctly typed
-in, then click on 'Reset Password' button. If password was reset successfully
-an alter message will pop up.</p>
+<p>The <strong>present users list</strong> comes with the "User Name", "User
+Description, "User Actions", "User Role" and "User Role Actions" columns.
+User Actions contain "Edit" and "Delete User" icons.</p>
+
+<p>Clicking the "Edit" icon opens a page on which you can edit the
+corresponding user details - change the role name of the user and reset the
+password. Once a new user role is selected from the list, click 'Update Role'
+to update the changes. If the role has been successfully changed, a message
+will appear confirming the change. To reset the password, the new password
+and the confirmation of the new password (same as the new password) should be
+correctly entered. Then click 'Reset Password'. If the password was reset
+successfully, a message will appear.</p>
<p><img alt="Figure:User Management-Edit User" src="images/edit_user.jpg"
/><br />
@@ -724,13 +721,13 @@
typed in and clicked on 'Reset Password' button to reset password. If
password is reset successfully, then an alert message will pop up saying
so.</p>-->
-Using "Delete user" icon you can delete the corresponding user. Using "Delete
-Role" icon under the "User Role Actions" column one can delete the user role.
-<a id="manage_transports"></a>
+Click the "Delete user" icon to delete the corresponding user. The "Delete
+Role" icon in the "User Role Actions" column can be used to delete the user
+role. <a id="manage_transports"></a>
<h2>Manage Transports</h2>
-<p>This page lists the https and http transports available, their names and
+<p>This page lists the available https and http transports, their names and
values.</p>
<p><img alt="Figure:Transport Management" src="images/manage_transports.jpg"
@@ -742,16 +739,16 @@
<h2>Manage Key Stores</h2>
-<p>This page allows you Key Store management. It lists the available key
-stores, name, type and actions- "<a href="#import_certificate">Importing
+<p>This page allows Key Store management. It lists the available key stores,
+name, type and the actions "<a href="#import_certificate">Importing
Certificates</a>" and "Delete Key Store", which removes the key store.</p>
-<p>The page also contains instructions to add a key store. This is a 3 step
-process:</p>
+<p>The page also contains instructions to add a key store. This is a three
+step process:</p>
<ol>
- <li>Upload key store file</li>
- <li>Enter Password for Private Key 'client'</li>
- <li>Key store upload complete</li>
+ <li>Upload the key store file</li>
+ <li>Enter the password for the Private Key 'client'</li>
+ <li>Key store upload complete. Exit Key store wizard.</li>
</ol>
<p><img alt="Figure:Key Store Management" src="images/keystores.jpg" /><br />
@@ -760,9 +757,9 @@
<p><strong>Figure:Key Store Management</strong></p>
<a id="import_certificate"></a>
-<p>Click on "<strong>Import Certificate</strong>" icon and it will take you
-to the page below. Here you have option of adding a certificate- "Browse" and
-"Upload". Imported certificate too will be listed here.</p>
+<p>Click the "<strong>Import Certificate</strong>" icon to open the page
+displayed below. Here you have option of importing a certificate- "Browse"
+and "Upload". Already imported certificates will also be listed here.</p>
<p><img alt="Figure:Import Certificate for Key Store"
src="images/import_certificate.jpg" /><br />
@@ -777,45 +774,46 @@
<a href="http://logging.apache.org/log4j/docs/index.html">Log4J</a> <a
href="#loggers">Loggers</a> and <a
href="http://logging.apache.org/log4j/docs/index.html">Log4J</a> <a
-href="#appenders">Appenders</a>. Loggers filter log messages to Appenders,
-while Appenders filter the messages for the second time before writing to the
-log files.</p>
+href="#appenders">Appenders</a>. Loggers filter the log messages to
+Appenders, while Appenders filter the messages for the second time before
+writing them to the log files.</p>
<a id="loggers"></a>
<h3>Configure Log4J Loggers:</h3>
-<p>Log4J Loggers contain the values- Name, Log Level and Additivity.
-<strong>Log level</strong> list contains TRACE, INFO, DEBUG, WARN, ERROR,
+<p>Log4J Loggers contain the values Name, Log Level and Additivity.
+The<strong> Log level</strong> list contains TRACE, INFO, DEBUG, WARN, ERROR,
FATAL and OFF from which any one can be selected. Once you select a Log
-Level, only messages at that level and below will be logged. For example, if
-you select Log Level ERROR, then all ERROR and FATAL messages will be logged,
-rather passed on to the Appender. Switching on <strong>Additivity</strong>
-allows to inherit all the Appenders of the parent Logger.</p>
+Level, only the messages at that level and below will be logged. For example,
+if you select Log Level ERROR, then all ERROR and FATAL messages will be
+logged or rather passed on to the Appender. Switching on
+<strong>Additivity</strong> allows to inherit all the Appenders of the parent
+Logger.</p>
<a id="appenders"></a>
<h3>Configure Log4J Appenders:</h3>
-<p>Log4J Appenders include values for Appender Name, Log level, known as
+<p>Log4J Appenders include values for the Appender Name, Log level, known as
Threshold in this case, Log Pattern and Log File.</p>
-<p>The <strong>Threshold</strong> list is the same as Log Level in Loggers in
-name and action. The <strong>Log Pattern</strong> allows you to edit the
-format or the layout in which the logs are created. You can have a look at
-the <a
+<p>The <strong>Threshold</strong> list is the same as the Log Level in
+Loggers, in name and action. The <strong>Log Pattern</strong> allows you to
+edit the format or the layout in which the logs are created. You can have a
+look at the <a
href="http://logging.apache.org/log4j/docs/api/org/apache/log4j/PatternLayout.html">log4j
-PatternLayout</a> page to get the meanings of the values that are used in the
-log pattern. Finally you can change the location of the log file with the
+PatternLayout</a> page to learn the meanings of the values that are used in
+the log pattern. Finally you can change the location of the log file with the
<strong>Log File</strong> option.</p>
<a id="global"></a>
<h3>Global Log4J Configuration:</h3>
-<p>Note that using the Global Log4J Configuration options you can set Log
-Level and Log Pattern of Log4J Appenders and Loggers to the same value in one
-go.</p>
+<p>Note that by using the Global Log4J Configuration options, you can set the
+Log Level and Log Pattern of Log4J Appenders and Loggers to the same value at
+the same time.</p>
-<p>Values for the above 3 settings can be edited/changed and updated using
-Update button.</p>
+<p>Values for the above three settings can be edited/changed and updated by
+using the Update button.</p>
<p><img alt="Figure:Logging Management" src="images/configuration.jpg" /><br
/>
@@ -858,7 +856,7 @@
<p>The system log can be viewed on this page. Log entries will be categorized
into information messages, warning messages, error messages, fatal error
-messages & debug messages.</p>
+messages and debug messages.</p>
<p><img alt="Figure:Monitor Logs" src="images/log.jpg" /><br />
</p>
@@ -868,29 +866,29 @@
<h2>Monitor Tracer</h2>
-<p>This tracer shows the soap messages, their respective SOAP message
-requests and responses when services are deployed on the server and their
-operations invoked. Make sure that the messages are monitored by turning the
-SOAP Tracer ON. By default it is switched OFF. You can switch it on by
-selecting the ON value in the list box.</p>
+<p>This tracer shows the SOAP messages, their respective SOAP message
+requests and responses when the services are deployed on the server, and the
+invoked operations. Make sure that the messages are monitored by turning the
+SOAP Tracer on. By default, it is switched off. You can switch it on by
+selecting ON in the list.</p>
-<p><strong>Warning</strong>:Turning this ON will have a performance hit,
+<p><strong>Warning</strong>:Turning this on will have a performance hit,
since all SOAP messages will be always completely built (i.e. deferred
-building will not be done) and stored in the database by WSO2 WSAS hence this
-option should be used with caution.</p>
+building will not be done) and stored in the database by WSO2 WSAS. Hence
+this option should be used with caution.</p>
<p><img alt="Figure:Turn ON SOAP Tracer" src="images/tracer_off.jpg" /><br />
</p>
<p><strong>Figure: Turn ON SOAP Tracer</strong></p>
-<p>The tracer will only show the messages of operations invoked after point
-of switching ON the SOAP tracing.</p>
+<p>The tracer will only show the messages of the operations that were invoked
+after switching on the SOAP tracing.</p>
-<p>Using this SOAP tracer it is possible to see SOAP messages with their
-time-stamps, service name, operation invoked and the number of requests to
-the server. The most recent SOAP messages are listed on the top. When a
-particular SOAP message is selected it's Request and the Response can be
+<p>By using this SOAP tracer, it is possible to see the SOAP messages with
+their time-stamps, service name, operation invoked and the number of requests
+to the server. The most recent SOAP messages are listed on the top. When a
+particular SOAP message is selected, its Request and the Response can be
viewed in collapsible/expandable text boxes.</p>
<p>Note: This tracer does not apply to operations invoked in the admin
@@ -911,9 +909,9 @@
<p><strong>Figure: Monitor Flows- Graphical View</strong></p>
-<p>Using the "Text View" link on the top right hand corner of the page you
-can view the textual representation of In flow, Out flow, In-Out flow,
-Out-Fault flow SOAP message flows. Using the "Graphical View" link you can go
+<p>Click the "Text View" link on the top right hand corner of the page to
+view the textual representation of the In flow, Out flow, In-Out flow, and
+Out-Fault flow SOAP messages. By using the "Graphical View" link, you can go
back to the "Monitor Flows- Graphical View".</p>
<p><img alt="Monitor Flows- Textual View" src="images/monitor_flow_text.jpg"
@@ -928,18 +926,18 @@
<h3>Signing Out</h3>
-<p>Once signed in, in order to sign out form the system simply click on the
-Sign Out link on the right hand-top end of any page.</p>
+<p>Once signed in, to sign out from the system, click on the Sign Out link at
+the upper right-hand of any page.</p>
<a id="register"></a>
<h3>Register</h3>
<p>You can register your WSO2 WSAS instance by clicking on this link. By
-registering you will be providing the developers with valuable information to
-make WSO2 WSAS a better product. Only information that is shown to you on the
-Register Product page will be submitted to the server and you can change the
-information that is extracted from your WSO2 WSAS instance before you submit
-them to the server, if you wish to do so.</p>
+registering, you will be providing the developers with valuable information
+to make WSO2 WSAS a better product. Only information that is shown to you on
+the Register Product page will be submitted to the server, and you can change
+the information that is extracted from your WSO2 WSAS instance before you
+submit them to the server if you wish to do so.</p>
<p><img alt="Figure:Registration Page" src="images/register.jpg" /><br />
</p>
@@ -953,14 +951,15 @@
the Web browser you use to point to the WSO2 WSAS for Java AJAX Management
Console.</p>
-<h3>Internet Explorer 6 : </h3>
+<h3>Internet Explorer 6 :</h3>
<p>AJAX engines make use of an XMLHttpRequst object to exchange data
asynchronously with remote servers. In Internet Explorer 6, this object is
implemented with ActiveX rather than native JavaScript, which requires that
-ActiveX be enabled to run WSO2 WSAS for Java Management Console. </p>
+ActiveX be enabled to run WSO2 WSAS for Java Management Console.</p>
-<p>Once you have configured your Web browser as above, see <a
-href="#signin">Signing In</a> section on how to access Management Console.</p>
+<p>Once you have configured your Web browser as above, see the <a
+href="#signin">Signing In</a> section on how to access the Management
+Console.</p>
</body>
</html>
More information about the Wsas-java-dev
mailing list