X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Fman_stats.html;h=c12b591d8483d9dd95d42ba55996b1c057b8c852;hb=b895c8df3e237da572dc256cb5f8d4d1f3e58f8a;hp=63e0657bf24bce7135de0d6c42b5698092788352;hpb=62f0311ee16ac52e1854635196c152ed6ccdddb3;p=jabaws.git

diff --git a/website/man_stats.html b/website/man_stats.html
index 63e0657..c12b591 100644
--- a/website/man_stats.html
+++ b/website/man_stats.html
@@ -61,14 +61,14 @@
   <li><a href="#exec_stat_conf">Configuring JABAWS execution statistics</a></li>
 </ul>
 <h3><a name="usage_sum"></a>Summary of Usage </h3>
-<p>JABAWS comes with a web application for visualizing usage statistics. The screenshot below shows the main page of this application. Each month is a link to the detailed usage statistics for this month described later. Please note however, that the links to the detailed monthly statistics are only available for authenticated users in the role <span class="hightlight">admin</span>. There is a link at the bottom of the page that would let you login, if you have not done so. </p>
-<p>If you are using JABAWS VA (Virtual Appliance) then the username is <span class="hightlight">jabaws</span> and password is not defined, e.g. empty. </p>
+<p>JABAWS comes with a web application for visualizing usage statistics. The screenshot below shows the main page of this application. The individual month is linked to detailed usage statistics (described later). Please note, that the links to the detailed monthly statistics are only available for authenticated users in the role <span class="hightlight">admin</span>. There is a link at the bottom of the page that lets you login, if you have not done so. </p>
+<p>If you are using JABAWS VA (Virtual Appliance) then the username is <span class="hightlight">jabaws</span> and password is not defined, i.e. empty. </p>
 <p>If you have deployed a JABAWS WAR file, then please see the <a href="#conf_tomcat_user">configuring privileged   access for Tomcat web application server</a> section for further details. </p>
 <p><img src="images/usage_statistics_main.gif" alt="JABAWS usage statistics" width="608" height="318" /></p>
 <p>The table contains the number of jobs processed by JABAWS per month, for the whole   period when the statistics was collected</p>
 <p>For each month the table contains the following information.</p>
 <ul>
-  <li>Month - the period of time for which statistics is displayed. For example Jan 2011 means period of time from the first of January to the first of February.</li>
+  <li>Month - the period of time for which statistics is displayed. For example Jan 2011 means period of time from the first of January to the first of February</li>
   <li>Total - the total number of jobs accepted by JABAWS</li>
   <li>Incomplete - the number of jobs for which the result file was not found or was empty excluding cancelled</li>
   <li>Cancelled - the number of jobs cancelled by the user</li>
@@ -76,17 +76,17 @@
 </ul>
 <p>The summary for each column is displayed in the last row of the table.</p>
 <h3><a name="helpUsageStats"></a>Authentication</h3>
-<p>Authentication lets you see the detailed usage statistics. If you are using JABAWS VA (Virtual Appliance) then the username is <span class="hightlight">jabaws</span> and password is not defined, e.g. empty. In other cases you need to ask your system administrator for it. </p>
+<p>Authentication lets you see the detailed usage statistics. If you are using JABAWS VA (Virtual Appliance) then the username is <span class="hightlight">jabaws</span> and password is not defined, i.e. empty. In other cases you need to ask your system administrator for it. </p>
 <h3><a name="detailed_usage"></a>Detailed Usage Statistic  </h3>
 <p>Detailed execution statistics for each month is available for authenticated users only. </p>
 <p><img src="images/usage_statistics_month.gif" alt="JABAWS one month usage statistics" width="670" height="902" /></p>
-<p>Each table contains the number of jobs processed by JABAWS during the period of   time specified in the title.</p>
+<p>Each table contains the number of jobs processed by JABAWS during the period of   time specified in the title:</p>
 <ul>
-  <li>The &quot;All Jobs&quot; table contains the summary of all jobs.</li>
-  <li>&quot;Local Jobs&quot; table - contains the summary of the jobs calculated by the local engine.</li>
-  <li>&quot;Cluster Jobs&quot; table - contains the summary of the jobs calculated by the cluster.</li>
+  <li>The &quot;All Jobs&quot; table contains the summary of all jobs</li>
+  <li>&quot;Local Jobs&quot; table - contains the summary of the jobs calculated by the local engine</li>
+  <li>&quot;Cluster Jobs&quot; table - contains the summary of the jobs calculated by the cluster</li>
 </ul>
-Each table contains the following information for each web service
+Each table contains the following information for each web service:
 <ul>
   <li>Total - the total number of jobs accepted by a particular JABA service</li>
   <li>Incomplete - the number of jobs for which the result file was not found or was empty excluding cancelled</li>
@@ -94,9 +94,9 @@ Each table contains the following information for each web service
   <li>Abandoned - the number of jobs which result(s) were not collected</li>
 </ul>
 <h3><a name="job_list"></a>Job List </h3>
-<p>Please note that if you deployed JABAWS WAR, in order to be able to navigate to the job directory from this view the application server may need to be configured. Please see  <a href="#exec_stat_conf">Configuring JABAWS execution statistics</a> section for further details. </p>
+<p>Please note that if you deployed JABAWS WAR, in order to be able to navigate to the job directory from this view, the application server may need to be configured. Please see  <a href="#exec_stat_conf">Configuring JABAWS execution statistics</a> section for further details. </p>
 <p><img src="images/usage_statistics_details.gif" alt="JABAWS - job list" width="917" height="198" /> </p>
-<p>Columns </p>
+<p>Columns: </p>
 <ul>
   <li>JobID - the JABAWS job id, unique for every job</li>
   <li>Cluster JobID - cluster job id</li>
@@ -107,7 +107,7 @@ Each table contains the following information for each web service
   <li>Finish time (s)- job's finish time and date</li>
   <li>isCancelled - whether the job was cancelled</li>
   <li>isCollected - whether the job was collected. False for the jobs   that has been initiated but which results has never been retrieved</li>
-  <li>isFinished - whether the job has finished. This does not necessarily mean that the job has produced the result.   	The job can sometime finish in failure.</li>
+  <li>isFinished - whether the job has finished. This does not necessarily mean that the job has produced the result.   	The job can sometime finish in failure</li>
 </ul>
 <h3><a name="job_dir"></a>JABAWS Job Directory Content </h3>
 <p><img src="images/usage_statistics_job_details.gif" alt="JABAWS- job details" width="716" height="420" /></p>
@@ -117,10 +117,10 @@ Each table contains the following information for each web service
 <p>procError.txt and procOutput.txt files  contains the content of the standard out and standard error streams of the process. </p>
 <p>result.txt file contains the results. </p>
 <p>input.txt file contains input into the process. </p>
-<p>There are maybe other files depending on the nature of the job, but the one described above will present in most cases. In this example, stat.log file stories the execution statistics generated by the process (clustal executable in this example).</p>
+<p>There are maybe other files depending on the nature of the job, but the one described above will be present in most cases. In this example, stat.log file stories the execution statistics generated by (clustal executable in this example) process.</p>
 <p> If you have deployed JABAWS WAR file or made changes to JABAWS configuration you may need to make a few changes to the Tomcat configuration to be able to see the content of the job directory. Please see <a href="#exec_stat_conf">Configuring JABAWS execution statistics</a> section for further details. </p>
 <h3><a name="exec_stat_conf"></a>Configuring JABAWS execution statistics</h3>
-<p>JABAWS execution statistics is a multi-component system. First is a crawler which job is to collect and preprocess the statistics from the job temporary directories and record the collected statistics into the database. The second part of the system is a web application which job is to visualise the statistics from the database. </p>
+<p>JABAWS execution statistics is a multi-component system. First is a crawler whose job is to collect and preprocess the statistics from the job temporary directories and record the collected statistics into the database. The second part of the system is a web application whose job is to visualise the statistics from the database. </p>
 <p>It is possible to enable/disable the statistics collector by changing the following properties in the conf/Cluster.engine.properties and conf/Local.engine.properties files. </p>
 <p class="box"># Enable/disable cluster statistics collector true = enable, false = disable <br/>
   cluster.stat.collector.enable=false
@@ -147,7 +147,7 @@ Each table contains the following information for each web service
 <p><br/>
 </p>
 </div><!-- content end-->
-<div id="copyright">Last update: 14 October 2013<br/>Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>
+<div id="copyright">Last update: 30 April 2014<br/>Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>
 </div><!-- wrapper end-->
 </div><!-- page end-->