[esb-java-dev] svn commit r2996 -
trunk/esb/java/modules/distribution/src/main/docs
svn at wso2.org
svn at wso2.org
Mon May 21 23:21:57 PDT 2007
Author: marietta
Date: Mon May 21 23:21:51 2007
New Revision: 2996
Modified:
trunk/esb/java/modules/distribution/src/main/docs/administratorguide.html
Log:
documentation in progress
Modified: trunk/esb/java/modules/distribution/src/main/docs/administratorguide.html
==============================================================================
--- trunk/esb/java/modules/distribution/src/main/docs/administratorguide.html (original)
+++ trunk/esb/java/modules/distribution/src/main/docs/administratorguide.html Mon May 21 23:21:51 2007
@@ -18,23 +18,98 @@
which define the console. It also provides a section on how to interpret the
statistics generated by the system.</p>
-<p></p>
-
-<p></p>
+<p>The WSO2 Management Console has been tested on Mozilla Firefox and
+Internet Explorer 6 and 7.</p>
<p></p>
<p><strong>Table of Contents</strong></p>
+<div class="toc">
+<ul>
+ <li><a href="#Installing">Installing ESB</a></li>
+ <li><a href="#Signing">Signing In</a>
+ <ul>
+ <li><a href="#Changing">Changing Your User Name and Password</a></li>
+ <li><a href="#Icons">Icons and Descriptions</a></li>
+ </ul>
+ </li>
+ <li><a href="#Managing">Managing the Elements in a Synapse Configuration</a>
+ <ul>
+ <li><a href="#Proxy">Proxy Services</a>
+ <ul>
+ <li><a href="#Adding">Adding a Proxy Service</a></li>
+ <li><a href="#Proxy1">Proxy Service Actions</a></li>
+ </ul>
+ </li>
+ <li><a href="#Endpoints">Endpoints</a>
+ <ul>
+ <li><a href="#Adding1">Adding an Endpoint</a></li>
+ <li><a href="#Endpoint">Endpoint Actions</a></li>
+ </ul>
+ </li>
+ <li><a href="#Sequences">Sequences</a>
+ <ul>
+ <li><a href="#Adding2">Adding a Sequence</a></li>
+ <li><a href="#Adding3">Adding Core Mediators</a></li>
+ <li><a href="#Adding4">Adding Transform Mediators</a></li>
+ <li><a href="#Adding5">Adding Filters</a></li>
+ <li><a href="#Adding6">Adding Extensions</a></li>
+ <li><a href="#Sequence">Sequence Actions</a></li>
+ </ul>
+ </li>
+ <li><a href="#Local">Local Registry Entries</a>
+ <ul>
+ <li><a href="#Local1">Add a Local Registry Entry</a></li>
+ <li><a href="#Registry">Registry Actions</a></li>
+ </ul>
+ </li>
+ <li><a href="#Configurat">Configuration</a></li>
+ </ul>
+ </li>
+ <li><a href="#Managing1">Managing the Integrated Registry</a>
+ <ul>
+ <li><a href="#Manage">Manage Registry Entry</a></li>
+ </ul>
+ </li>
+ <li><a href="#Monitoring">Monitoring the System</a>
+ <ul>
+ <li><a href="#System">System Information</a></li>
+ <li><a href="#Statistics">Statistics</a></li>
+ <li><a href="#System1">System Logs</a></li>
+ <li><a href="#Trace">Trace Messages</a></li>
+ </ul>
+ </li>
+</ul>
+</div>
+
<p></p>
-<h2>Installing ESB</h2>
+<h2 id="Installing">Installing the ESB Management Console</h2>
-<p></p>
+<p>Please refer to the Installation Guide for details on how to install the
+WSO2 Management Console.</p>
-<p></p>
+<h3>Known Issues and Limitations in this Version</h3>
+
+<p>1. It is not possible to use the HTTPS transport with a JDK version below
+1.5</p>
-<h2>Signing In</h2>
+<p>If a JDK version below 1.5 is being used, the existing
+<transportReceiver> and <transportSender> elements of the
+conf/axis2.xml must be replaced as <a href="issue1.html">follows</a>. This
+will allow the admin console to run over https transport, although services
+are accessible only over http.</p>
+
+<p>2. Dependencies are currently allowed to be removed while they have live
+references to them.</p>
+
+<p>The ESB UI currently does not perform a check on references before
+elements are allowed to be removed. Thus it is possible to define references
+to non-existent endpoints, sequences etc. as well as remove them while live
+referencs still exist</p>
+
+<h2 id="Signing">Signing In</h2>
<p>Enter your user name and password to log on to the ESB Management
Console.</p>
@@ -44,7 +119,7 @@
errors when trying to sign in, click <strong>Sign-in Help</strong>. A list of
possible errors, their descriptions and solutions will be displayed.</p>
-<h3>Changing Your User Name and Password</h3>
+<h3 id="Changing">Changing Your User Name and Password</h3>
<p>To change the username and password, modify the [file name] file in
[location].</p>
@@ -58,9 +133,9 @@
<p></p>
<hr>
-<h3>Icons and Descriptions</h3>
+<h3 id="Icons">Icons and Descriptions</h3>
-<table>
+<table border="1">
<caption></caption>
<tbody>
<tr>
@@ -68,16 +143,50 @@
<td>Description</td>
</tr>
<tr>
- <td></td>
- <td></td>
+ <td><img alt="add" src="images/add_m.gif"></td>
+ <td><strong>Add</strong> - Click this icon to add an item. Most often
+ clicking on this icon gives a submenu from which you can select an
+ element. </td>
</tr>
<tr>
- <td></td>
- <td></td>
+ <td><img alt="edit" src="images/edit_m.gif"></td>
+ <td><strong>Edit</strong> - Click this icon to modify an existing
+ item.</td>
+ </tr>
+ <tr>
+ <td><img alt="delete" src="images/delete_m.gif"></td>
+ <td><strong>Delete</strong> - Click this icon to permanently delete an
+ item. A message will appear prompting you to confirm the
+ deletion.</td>
+ </tr>
+ <tr>
+ <td><img alt="Stats Enabled" src="images/stat_s.gif"></td>
+ <td><strong>Disable Statistics</strong> - This icon indicates that
+ statistics generation is in progress. Click this icon to stop
+ statistics generation for the respective element.</td>
+ </tr>
+ <tr>
+ <td><img alt="Stats Disabled" src="images/stat_s_disabled.gif"></td>
+ <td><strong>Enable Statistics</strong> - This icon indicates that
+ statics are not been generated at present. Click this icon to start
+ statistics generation for the respective element.</td>
+ </tr>
+ <tr>
+ <td><img alt="Trace Enabled" src="images/tracer_s.gif"></td>
+ <td><strong>Disable Tracing</strong> - This icon indicates that message
+ tracing is in progress. Click this icon to stop tracing for the
+ respective element.</td>
+ </tr>
+ <tr>
+ <td><img alt="Trace Disabled" src="images/tracer_s_disabled.gif"></td>
+ <td><strong>Enable Tracing</strong> - This icon indicates that messages
+ are not been traced at present. Click this icon to start tracing
+ messages for the respective element.</td>
</tr>
<tr>
<td></td>
- <td></td>
+ <td><strong>Update</strong> - Click this icon to save your current
+ changes, modifications, etc.</td>
</tr>
<tr>
<td></td>
@@ -86,13 +195,13 @@
</tbody>
</table>
-<h2>Managing the Elements in a Synapse Configuration</h2>
+<h2 id="Managing">Managing the Elements in a Synapse Configuration</h2>
<p>The Synapse configuration language consists of endpoints, sequences,
registry entries, and proxy services. Messages coming into Synapse is
processed based on the mediators and delivered to a specified endpoint.</p>
-<h3>Proxy Services</h3>
+<h3 id="Proxy">Proxy Services</h3>
<p>Proxy services define virtual services hosted on the ESB, that are able to
accept requests, mediate them, and deliver them to the actual service. Proxy
@@ -102,7 +211,7 @@
<p></p>
-<h4>Adding a Proxy Service</h4>
+<h4 id="Adding">Adding a Proxy Service</h4>
<p>This function allows you to add a proxy service using a basic
configuration or an advanced configuration. The basic configuration consists
@@ -167,8 +276,6 @@
<li>Click <strong>Save</strong>. Anonymous Sequence will be displayed
next to the target sequence.</li>
</ol>
-
- <p></p>
<ul>
<li><strong>Pick from Registry</strong> - Specifies a sequence from the
ESB registry.</li>
@@ -291,13 +398,17 @@
</li>
</ol>
-<h4>Proxy Service Actions</h4>
+<h4 id="Proxy1">Proxy Service Actions</h4>
<p>You can edit, delete, enable statistics, start and stop the proxy server,
and enable tracing for the proxy service as described below. All existing
proxy services will be displayed in the Proxy Services table along with their
current status. The proxy service actions are initiated by clicking on the
-respective icons in the table. (screen shot)</p>
+respective icons in the table.</p>
+
+<p></p>
+
+<p><img alt="Proxy Services" src="images/proxytable.jpg"></p>
<blockquote>
<p><strong>Edit Proxy Service</strong></p>
@@ -364,7 +475,7 @@
<p></p>
-<h3>Endpoints</h3>
+<h3 id="Endpoints">Endpoints</h3>
<p>An endpoint is a specific destination for a message. It may be specified
as an Address endpoint, WSDL endpoint, a Failover group, or a Loadbalance
@@ -374,21 +485,21 @@
Failover and Load-balance endpoints cannot be deleted. You can also enable
statistics for Address and WSDL endpoints.</p>
-<h4>Adding an Endpoint</h4>
+<h4 id="Adding1">Adding an Endpoint</h4>
<p></p>
<ol>
<li>Click <strong>Endpoints</strong> on the navigator.</li>
<li>In the Manage Endpoints pane, click <strong>Add</strong> and select the
endpoint you want to configure.
- <p>(screen shot)</p>
+ <p><img alt="Add Endpoint" src="images/addendpoint.jpg"></p>
</li>
</ol>
<blockquote>
<p><strong>Address Endpoint</strong></p>
- <p>(screen shot)</p>
+ <p></p>
<p>An endpoint defined by specifying the EPR and other attributes of the
endpoint directly in the configuration.</p>
@@ -425,7 +536,7 @@
<p><strong>WSDL Endpoint</strong></p>
- <p>(screen shot)</p>
+ <p></p>
<p>An endpoint based on a WSDL document. A WSDL document can be specified
by giving a URI or in-line as a child element of the WSDL element.</p>
@@ -474,7 +585,7 @@
<blockquote>
<p><strong>Failover Endpoint</strong></p>
- <p>(screen shot)</p>
+ <p></p>
<p>Failover endpoints send messages to the listed endpoints. It treats the
first endpoint as the primary endpoint and the rest as backups. Therefore,
@@ -505,7 +616,7 @@
<blockquote>
<p><strong>Load-balance Endpoint</strong></p>
- <p>(screen shot)</p>
+ <p></p>
<p>Distributes the arriving messages (load) among the set of listed
endpoints by evaluating the load balancing policy and other parameters.
@@ -530,14 +641,14 @@
</ol>
</blockquote>
-<h4>Endpoint Actions</h4>
+<h4 id="Endpoint">Endpoint Actions</h4>
<p>You can edit, delete, and enable statistics for endpoints as described
below. All existing endpoints will be displayed in the Endpoints table. The
endpoint actions are initiated by clicking on the respective icons in the
table.</p>
-<p></p>
+<p><img alt="Endpoints" src="images/endpointstable.jpg"></p>
<blockquote>
<p><strong>Edit Endpoint</strong></p>
@@ -579,7 +690,7 @@
</ul>
</blockquote>
-<h3>Sequences</h3>
+<h3 id="Sequences">Sequences</h3>
<p>A sequence element is used to define a sequence of mediators that can be
invoked later as a sequence. If the configuration defines a sequence named
@@ -601,7 +712,7 @@
<p>Extension: Class, Script, Spring, and RMSequence</p>
-<h4>Adding a Sequence</h4>
+<h4 id="Adding2">Adding a Sequence</h4>
<p>You can create completely new sequences, or copy an existing sequence (its
mediators and properties) and rename it.</p>
@@ -611,7 +722,9 @@
<p>The <em>Define New Sequence</em> page will be displayed.</p>
</li>
<li>On this page, click the Add Mediator icon, and select the appropriate
- mediator from the context menu.</li>
+ mediator from the context menu.
+ <p><img alt="Add mediator" src="images/mediators.jpg"></p>
+ </li>
<li>Enter the details for the selected mediator. (Each mediator is
described below.)
<ul>
@@ -651,7 +764,7 @@
</li>
</ul>
-<h4>Adding Core Mediators</h4>
+<h4 id="Adding3">Adding Core Mediators</h4>
<p></p>
@@ -732,7 +845,7 @@
<li>Click the Update icon to save your changes.</li>
</ol>
-<h4>Adding Transform Mediators</h4>
+<h4 id="Adding4">Adding Transform Mediators</h4>
<p><strong>Fault</strong> -</p>
<ol>
@@ -808,7 +921,7 @@
<li>Click the Update icon to save your changes.</li>
</ol>
-<h4>Adding Filters</h4>
+<h4 id="Adding5">Adding Filters</h4>
<p><strong>Filter </strong>-<strong> </strong>This mediator either tests the
given xpath expression as a boolean expression, or matches the evaluation
@@ -928,7 +1041,7 @@
<li>Click the Update icon to save your changes.</li>
</ol>
-<h4>Adding Extensions</h4>
+<h4 id="Adding6">Adding Extensions</h4>
<p><strong>Class</strong> - ?????</p>
<ol>
@@ -989,14 +1102,16 @@
<p></p>
-<h4>Sequence Actions</h4>
+<h4 id="Sequence">Sequence Actions</h4>
<p>You can edit, delete, enable statistics, and enable tracing for sequences
as described below. All existing sequences will be displayed in the Sequences
table. The sequence actions are initiated by clicking on the respective icons
in the table.</p>
-<p>(screen shot)</p>
+<p></p>
+
+<p><img alt="Sequences" src="images/seqtable.jpg"></p>
<blockquote>
<p><strong>Edit Sequence</strong></p>
@@ -1047,7 +1162,7 @@
</ul>
</blockquote>
-<h3>Local Registry Entries</h3>
+<h3 id="Local">Local Registry Entries</h3>
<p>The local registry entries are used to locally define resources such as
scripts, schemas, WSDLs, policies and other resources in a configuration.
@@ -1055,7 +1170,7 @@
static. An entry that exists in the local registry has higher precedence over
an entry with the same name that exists in the Integrated registry.</p>
-<h4>Add a Local Registry Entry</h4>
+<h4 id="Local1">Add a Local Registry Entry</h4>
<ol>
<li>Click <strong>Local Registry</strong> on the navigator.</li>
<li>In the Manage Local Registry Entries pane, click <strong>Add</strong>
@@ -1067,7 +1182,7 @@
<blockquote>
<ol>
<li>Enter a name for the entry.</li>
- <li>In the <strong>Value</strong> field, specify the property values </li>
+ <li>In the <strong>Value</strong> field, specify the property values</li>
<li>Click <strong>Save</strong>.<br>
</li>
</ol>
@@ -1091,14 +1206,14 @@
</ol>
</blockquote>
-<h4>Registry Actions</h4>
+<h4 id="Registry">Registry Actions</h4>
<p>You can edit and delete previously entered local registry entries. All
existing local registry entries will be displayed in the Registry Entries
table. The registry actions are initiated by clicking on the respective icons
in the table.</p>
-<p>(screen shot)</p>
+<p><img alt="Local Registry" src="images/localrepo.jpg"></p>
<blockquote>
<p><strong>Edit Local Registry Entry</strong></p>
@@ -1124,7 +1239,7 @@
</ol>
</blockquote>
-<h3>Configuration</h3>
+<h3 id="Configurat">Configuration</h3>
<p>This function commits the configuration changes you made to your local
disk. The XML?? code for your configuration is displayed in the Current
@@ -1146,9 +1261,9 @@
<p></p>
-<h2>Managing the Integrated Registry</h2>
+<h2 id="Managing1">Managing the Integrated Registry</h2>
-<p>The registry provides a mechanism of creating a remte server??? and
+<p>The registry provides a mechanism of creating a remote server??? and
maintaining dynamic files??? for separate elements. The folder structure
gives a clear view of the available files and easy access to modifying the
files. The files are cached in the server?? during the specified duration,
@@ -1161,11 +1276,13 @@
<p></p>
-<h4>Manage Registry Entry</h4>
+<h4 id="Manage">Manage Registry Entry</h4>
<p>You can create a structure by creating sub-folders, or simply add the
files to the root folders.</p>
+<p><img alt="Integrated Registry" src="images/integrated-reg.Jpg"></p>
+
<p></p>
<p><strong>Add Registry Entry</strong></p>
@@ -1212,14 +1329,14 @@
<p></p>
<hr>
-<h2>Monitoring the System</h2>
+<h2 id="Monitoring">Monitoring the System</h2>
<p>This feature provides information on the Administrator Console. It
-displays system information, statistics, logs, and trace messages. </p>
+displays system information, statistics, logs, and trace messages.</p>
<p></p>
-<h4>System Information</h4>
+<h4 id="System">System Information</h4>
<p>Displays information about the operating system, server name, Axis2
location, repository location and other information about the system. This
@@ -1227,7 +1344,7 @@
<p></p>
-<h4>Statistics</h4>
+<h4 id="Statistics">Statistics</h4>
<p>Displays statistics of the server, proxy service, endpoints, and
sequences. The statistics are generated only if the Enable Statistics option
@@ -1241,7 +1358,7 @@
statistics.</li>
</ul>
-<h4>System Logs</h4>
+<h4 id="System1">System Logs</h4>
<p>Displays all the messages generated by the system.</p>
<ul>
@@ -1256,7 +1373,7 @@
<p></p>
-<h4>Trace Messages</h4>
+<h4 id="Trace">Trace Messages</h4>
<p>Displays the message path of the messages sent from and received by the
server.</p>
More information about the Esb-java-dev
mailing list