[Openvas-commits] r6290 - in trunk/gsa: . src/html/src/help

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Thu Dec 31 11:32:41 CET 2009


Author: felix
Date: 2009-12-31 11:32:39 +0100 (Thu, 31 Dec 2009)
New Revision: 6290

Added:
   trunk/gsa/src/html/src/help/configure_escalators.htm4
Modified:
   trunk/gsa/ChangeLog
   trunk/gsa/src/html/src/help/configure_scanconfigs.htm4
   trunk/gsa/src/html/src/help/glossary.htm4
   trunk/gsa/src/html/src/help/new_task.htm4
   trunk/gsa/src/html/src/help/reports.htm4
   trunk/gsa/src/html/src/help/tasks.htm4
   trunk/gsa/src/html/src/help/view_report.htm4
Log:
* ChangeLog: Corrected paths.

* src/html/src/help/configure_escalators.htm4: New.

* src/html/src/help/configure_scanconfigs.htm4,
src/html/src/help/glossary.htm4,
src/html/src/help/new_task.htm4,
src/html/src/help/tasks.htm4,
src/html/src/help/view_report.htm4: Updated new and changed options.


Modified: trunk/gsa/ChangeLog
===================================================================
--- trunk/gsa/ChangeLog	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/ChangeLog	2009-12-31 10:32:39 UTC (rev 6290)
@@ -1,3 +1,15 @@
+2009-12-31  Felix Wolfsteller <felix.wolfsteller at intevation.de>
+
+	* ChangeLog: Corrected paths.
+
+	* src/html/src/help/configure_escalators.htm4: New.
+
+	* src/html/src/help/configure_scanconfigs.htm4,
+	src/html/src/help/glossary.htm4,
+	src/html/src/help/new_task.htm4,
+	src/html/src/help/tasks.htm4,
+	src/html/src/help/view_report.htm4: Updated new and changed options.
+
 2009-12-30  Jan-Oliver Wagner <jan-oliver.wagner at greenbone.net>
 
 	* src/html/src/help/tasks.htm4: Added information to
@@ -5,11 +17,11 @@
 
 2009-12-30  Felix Wolfsteller <felix.wolfsteller at intevation.de>
 
-	* src/html/help/configure_agents.htm4,
-	src/html/help/configure_credentials.htm4,
-	src/html/help/configure_targets.htm4,
-	src/html/help/configure_users.htm4,
-	src/html/help/tasks.htm4: Fixed typo.
+	* src/html/src/help/configure_agents.htm4,
+	src/html/src/help/configure_credentials.htm4,
+	src/html/src/help/configure_targets.htm4,
+	src/html/src/help/configure_users.htm4,
+	src/html/src/help/tasks.htm4: Fixed typo.
 
 2009-12-30  Felix Wolfsteller <felix.wolfsteller at intevation.de>
 

Added: trunk/gsa/src/html/src/help/configure_escalators.htm4
===================================================================
--- trunk/gsa/src/html/src/help/configure_escalators.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/configure_escalators.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -0,0 +1,124 @@
+m4_define(`PAGE_TITLE', `Help: Configure Escalators')
+m4_include(`header.m4')
+
+<div style="float:left;"><a href="/help/contents.html">Help Contents</a></div>
+<div style="float:right;"><a href="/omp?cmd=get_escalators">Jump to dialog</a></div>
+&nbsp;<br />
+
+<h1>Configure Escalators</h1>
+
+<p>
+Escalators can be added to <a href="glossary.html#task">tasks</a>.
+Escalators are hooked into the system. Whenever a configured event happens
+(e.g. a task finished), a chosen condition is checked (e.g. vulnerability
+with high threat level detected).
+If the condition is met, an action is performed (e.g. an email is sent to a
+specified adress).
+</p>
+
+<a name="newescalator"></a>
+<h2>New Escalator</h2>
+
+<p>
+To create an escalator the dialog offers these entries.
+Hit the button "Create Escalator" to submit the new escalator.
+The list of escalators will be updated.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td></td>
+  <td>Mandatory</td>
+  <td>Max Length</td>
+  <td>Syntax</td>
+  <td>Example</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>yes</td>
+  <td>80</td>
+  <td>Alphanumeric</td>
+  <td>EmailFinished</td>
+</tr>
+<tr class="even">
+  <td>Comment</td>
+  <td>yes</td>
+  <td>40</td>
+  <td>Alphanumeric</td>
+  <td></td>
+</tr>
+<tr class="odd">
+  <td>Event</td>
+  <td>yes</td>
+  <td>---</td>
+  <td>Choice</td>
+  <td>Done</td>
+<tr class="even">
+  <td>Condition</td>
+  <td>yes</td>
+  <td>--</td>
+  <td>Choice</td>
+  <td>Always</td>
+</tr>
+<tr class="odd">
+  <td>Method</td>
+  <td>yes</td>
+  <td>--</td>
+  <td>Choice</td>
+  <td>Email</td>
+</tr>
+</table>
+
+<a name="escalators"></a>
+<h2>Escalators</h2>
+
+<p>
+This table provides an overview of all created escalators.
+</p>
+
+<table class="gbntable">
+<tr class="gbntablehead2">
+  <td>Column</td>
+  <td>Description</td>
+</tr>
+<tr class="odd">
+  <td>Name</td>
+  <td>User-given name of the escalator.</td>
+</tr>
+<tr class="even">
+  <td>Event</td>
+  <td>Shows the event for which the condition has to be checked.</td>
+</tr>
+<tr class="odd">
+  <td>Condition</td>
+  <td>Condition to be checked when event happened.</td>
+</tr>
+<tr class="even">
+  <td>Method</td>
+  <td>Notification method.</td>
+</tr>
+</table>
+
+<a name="actions"></a>
+<h3>Actions</h3>
+
+<h4>Delete Escalator</h4>
+
+<p>
+Pressing the delete icon
+<img src="/img/delete.png" alt="Delete" title="Delete" />
+will immedialy remove the escalator and update the list.
+</p>
+
+<p>
+It is not possible to remove an escalator that is in use by a task.
+</p>
+
+<h4>Escalator Details</h4>
+
+<p>
+Details of an escalator can be seen by clicking on the details icon
+<img src="/img/details.png" alt="Details" title="Details" />.
+</p>
+
+m4_include(`footer.m4')

Modified: trunk/gsa/src/html/src/help/configure_scanconfigs.htm4
===================================================================
--- trunk/gsa/src/html/src/help/configure_scanconfigs.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/configure_scanconfigs.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -52,11 +52,13 @@
   <td>All-inclusive scan which might consume quite some time.</td>
 </tr>
 <tr class="odd">
-  <td>Import config file</td>
+  <td>Base</td>
   <td>yes</td>
   <td>---</td>
-  <td>A openvasrc scope configuration file of OpenVAS-Client</td>
-  <td>~/.openvas/mytask/myscope/openvasrc<br>
+  <td>A predefined base scan configuration or <br>
+      an scope configuration file of OpenVAS-Client (openvasrc)</td>
+  <td>Full and Fast<br>
+      ~/.openvas/mytask/myscope/openvasrc<br>
       ~/.openvas/.Servers/myserver/mytask/openvasrc</td>
 </tr>
 </table>
@@ -144,4 +146,16 @@
 such as the selected NVTs and applied settings.
 </p>
 
+<h4>Edit Scan Config</h4>
+
+<p>
+A Scan Config can be modified if it is not currently in use by a task.
+A click on the edit icon
+<img src="/img/edit.png" alt="Edit" title="Edit" />
+will open the Scan Config Details dialog with details on the configuration
+such as the selected NVTs and applied settings and allow modifications of it.
+If the Scan Config is currently in use by a task, the icon will appear greyed
+out <img src="/img/edit_inactive.png" alt="Editing not possible" title="Editing not possible" />.
+</p>
+
 m4_include(`footer.m4')

Modified: trunk/gsa/src/html/src/help/glossary.htm4
===================================================================
--- trunk/gsa/src/html/src/help/glossary.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/glossary.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -19,6 +19,17 @@
 terms as they are used in GSA.
 </p>
 
+
+<a name="escalator"></a>
+<h2>Escalator</h2>
+
+<p>
+An escalator is an action that can be triggered at certain events.
+Usually this means notification, e.g. via e-mail in case of
+new found vulnerabilities.
+</p>
+
+
 <a name="nvt"></a>
 <h2>Network Vulnerability Test (NVT)</h2>
 

Modified: trunk/gsa/src/html/src/help/new_task.htm4
===================================================================
--- trunk/gsa/src/html/src/help/new_task.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/new_task.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -8,7 +8,7 @@
 <h1>New task</h1>
 <a name="newtask"></a>
 <p>
-For creating a new <a href="/help/glossary.html#task">task</a>
+To create a new <a href="/help/glossary.html#task">task</a>
 you have to provide the following elements:
 </p>
 
@@ -27,7 +27,7 @@
   <td>Alphanumeric</td>
   <td>All Windows desktops in-depth</td>
 </tr>
-<tr>
+<tr class="even">
   <td>Scan Type</td>
   <td>yes</td>
   <td>---</td>
@@ -44,6 +44,15 @@
       <a href="/help/configure_targets.html">configured targets</a>.</td>
   <td>The Windows Desktops</td>
 </tr>
+<tr class="even">
+  <td>Escalator (optional)</td>
+  <td>no</td>
+  <td>---</td>
+  <td>One of the
+      <a href="/help/configure_escalators.html">configured escalators</a>.
+  </td>
+  <td>EmailFinished</td>
+</tr>
 </table>
 
 <p>

Modified: trunk/gsa/src/html/src/help/reports.htm4
===================================================================
--- trunk/gsa/src/html/src/help/reports.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/reports.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -11,6 +11,11 @@
 <p>
 This information dialog lists name, status and number of reports for
 the task for which the report list is shown below.
+It also lists the <a href="glossary.html#scanconfig">Scan Config</a>,
+<a href="glossary.html#escalator">Escalator</a> and <a href="glossary.html#target">Target</a> for the shown report, if
+any were chosen. Information about the chosen Scan Config, Escalator or
+Target is accessible by clicking on the respective items name.
+
 </p>
 
 <a name="reports"></a>

Modified: trunk/gsa/src/html/src/help/tasks.htm4
===================================================================
--- trunk/gsa/src/html/src/help/tasks.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/tasks.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -211,6 +211,15 @@
 </tr>
 </table>
 
+<a name="sorting"></a>
+<h3>Sorting</h3>
+
+The table can be sorted either by the Task name or by the Status column.
+Therefore click on the descending <img src="/img/descending.png" alt="Sort descending" title="Sort descending" />
+or ascending <img src="/img/ascending.png" alt="Sort ascending" title="Sort ascending" /> icon.
+The icon of the current choice will appear greyed out <img src="/img/ascending_inactive.png" alt="Current sort ascending" title="Current sort ascending" />, <img src="/img/descending_inactive.png" alt="Current sort descending" title="Current sort descending" />.
+The list will be updated immediately.
+
 <a name="actions"></a>
 <h3>Actions</h3>
 

Modified: trunk/gsa/src/html/src/help/view_report.htm4
===================================================================
--- trunk/gsa/src/html/src/help/view_report.htm4	2009-12-31 07:44:14 UTC (rev 6289)
+++ trunk/gsa/src/html/src/help/view_report.htm4	2009-12-31 10:32:39 UTC (rev 6290)
@@ -24,4 +24,29 @@
 <a href="/help/glossary.html#task">task</a>.
 </p>
 
+<h2>Download a report</h2>
+
+<p>
+To download the currently shown report, the format can be chosen.
+The download will start shortly after a click on the "Download" button.
+</p>
+
+<h2>Result Sorting</h2>
+
+<p>
+Results shown on the page can be sorted either by the port number or by threat
+level, and ascending or descending.
+The sort oder is changed by clicking on the respective text (e.g.
+"threat ascending").
+</p>
+
+<h2>Result Filtering</h2>
+
+<p>
+A checkbox for each threat level (High, Medium, Low and Log) can be ticked to
+include results of the respective thread level in the shown report or unticked
+to exclude these issues from the shown report.
+The list of results is updated after a click on the "Apply" button.
+</p>
+
 m4_include(`footer.m4')



More information about the Openvas-commits mailing list