Merge pull request #4648 from g-pan/H9642-TechPrv

HPCC-9642 Update Tech Preview docs

Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/ECLWatch/ECLWTechPrev.xml

@@ -58,7 +58,7 @@
 
       <para>ECL Watch provides an interface to the HPCC system and allows you
       to view information and interrogate nodes to confirm all expected
-      processes are running. This provides a simple centric view into the
+      processes are running. This provides a simple Web-based view into the
       system and a means to perform Workunit and data files
       maintenance.</para>
 
@@ -76,16 +76,14 @@
         </figure></para>
 
       <para>On the ECL Watch page, there are links in the Navigator panel
-      underneath the <emphasis role="bold">Tech Preview</emphasis> heading.
-      The links below the header open the respective pages for the new
-      ECLWatch. The pages available through the Tech Preview are ECL
-      Workunits, DFU Workunits, and Logical Files.</para>
+      under the <emphasis role="bold">Tech Preview</emphasis> heading. The
+      links below the header open the respective pages for the new ECL Watch.
+      There are pages available through the Tech Preview that allow you to
+      access ECL Workunits, DFU Workunits, and Logical Files.</para>
 
       <para>For the preview period, these pages are only available through the
-      Tech Preview links. These pages will later replace the ECL Browse
-      Workunits, Browse DFU Workunits, and the Browse Logical Files pages. In
-      addition each page has filter capabilities, so the search pages will
-      also be replaced. </para>
+      Tech Preview link. These redesigned pages with the improved
+      functionality will later replace ECL Watch.</para>
     </sect1>
 
     <xi:include href="ECLWatch/ECLWa_mods/ECLWatchSrc.xml"
@@ -99,10 +97,17 @@
     <xi:include href="ECLWatch/ECLWa_mods/ECLWatchSrc.xml"
                 xpointer="LogicalFiles"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
-                
+
+    <xi:include href="ECLWatch/ECLWa_mods/ECLWatchSrc.xml"
+                xpointer="Landing_Zones"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+    <xi:include href="ECLWatch/ECLWa_mods/ECLWatchSrc.xml"
+                xpointer="Pub_Query"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+
     <xi:include href="ECLWatch/ECLWa_mods/ECLWatchSrc.xml"
-		xpointer="Landing_Zones"
+                xpointer="Operations"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
-                
   </chapter>
 </book>

docs/ECLWatch/ECLWa_mods/ECLWatchSrc.xml

@@ -65,14 +65,13 @@
 
       <para>ECL Watch provides an interface to the HPCC system and allows you
       to view information and interrogate nodes to confirm all expected
-      processes are running. This provides a simple centric view into the
-      system and a means to perform Work Unit and data files
-      maintenance.***</para>
+      processes are running. This provides a simple view into the system and a
+      means to perform Work Unit and data files maintenance.***</para>
 
       <para>Using ECL watch assumes your HPCC system is up and running, able
       to process jobs, and workunits. You would use the ECL Watch interface to
       both check the status of your jobs, and perform operations on those
-      jobs.</para>
+      jobs.***</para>
     </sect1>
 
     <sect1 id="ECLWorkunits" role="brk">
@@ -83,8 +82,19 @@
       can also perform actions on the selected workunit using the Workunit
       Action buttons.</para>
 
-      <para>Using the Navigator panel on the left, click on the <emphasis
-      role="bold">Browse Workunits </emphasis>link.</para>
+      <para>To access the workunits page click on the<emphasis role="bold">
+      ECL</emphasis> icon, then click the <emphasis
+      role="bold">Workunits</emphasis> link from the navigation sub-menu.
+      <figure>
+          <title>ECL Files</title>
+
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="../../images/ECLWA00A.jpg"
+                         vendor="eclwatchSS" />
+            </imageobject>
+          </mediaobject>
+        </figure></para>
 
       <para>The page displays the ECL workunits on your system. Choose
       the<emphasis role="bold"> Workunits</emphasis> Navigation tab to display
@@ -102,8 +112,8 @@
         </figure></para>
 
       <para>To further examine a workunit or to perform some action on it, you
-      must select it. You can select the workunit by checking the check
-      box.<figure>
+      must select it. You can select the workunit by checking the check box.
+      You can also open a work unit by double-clicking on the workunit.<figure>
           <title>Select ECL Workunit</title>
 
           <mediaobject>
@@ -175,7 +185,7 @@
         </listitem>
       </itemizedlist>
 
-      <sect2>
+      <sect2 role="brk">
         <title>Filter Options</title>
 
         <para>You can filter the workunits displayed on the Workunits tab by
@@ -395,12 +405,21 @@
       <para>The DFU Workunits page contains a list of all the DFU workunits on
       your system. It provides access to more details about the workunits. You
       can also perform actions on the selected workunit using the Workunit
-      Action buttons.</para>
+      Action buttons. <figure>
+          <title>Files Link</title>
+
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="../../images/ECLWA00D.jpg" />
+            </imageobject>
+          </mediaobject>
+        </figure></para>
 
-      <para>In the Navigator panel of the ECL Watch, click on the<emphasis
-      role="bold"> Browse </emphasis>link under <emphasis role="bold">DFU
-      Workunits</emphasis> header. This opens the DFU Workunits page. The page
-      displays the DFU Workunits on your system.</para>
+      <para>To access the DFU workunits page, click on the<emphasis
+      role="bold"> Files </emphasis>link on the navigation pane, then click
+      the <emphasis role="bold">Workunits</emphasis> link from the navigation
+      sub-menu. This action opens the DFU Workunits page. The page displays
+      the DFU Workunits on your system.</para>
 
       <para><figure>
           <title>Browse DFU Workunits</title>
@@ -477,7 +496,7 @@
       You can also double-click on a particular workunit to open the details
       tab.</para>
 
-      <sect2>
+      <sect2 role="brk">
         <title>DFU Filter Options</title>
 
         <para>You can filter the workunits displayed on the Workunits tab by
@@ -555,7 +574,7 @@
         </sect3>
       </sect2>
 
-      <sect2>
+      <sect2 role="brk">
         <title>DFU Workunit Details Page</title>
 
         <para>When you open the selected workunit(s) you will see the workunit
@@ -619,17 +638,17 @@
       also perform actions on selected files using the Workunit Action
       buttons.</para>
 
-      <para>In the Navigator panel of ECL Watch, click on the <emphasis
-      role="bold">Browse Logical Files </emphasis>link under the <emphasis
-      role="bold">DFU Files</emphasis> header. This will open the Logical
-      Files page.</para>
+      <para>To access the Logical Files page click on the <emphasis
+      role="bold">Files </emphasis>icon, then click the <emphasis
+      role="bold">Logical Files</emphasis> link from the navigation
+      sub-menu.</para>
 
       <para><figure>
-          <title>Browse Logical Files</title>
+          <title>Logical Files</title>
 
           <mediaobject>
             <imageobject>
-              <imagedata fileref="../../images/CSimg14.jpg"
+              <imagedata fileref="../../images/ECLWA430.jpg"
                          vendor="eclwatchSS" />
             </imageobject>
           </mediaobject>
@@ -727,7 +746,7 @@
       <para>You can press the <emphasis role="bold">Open</emphasis> button to
       open a tab with the details for each selected file.</para>
 
-      <sect2>
+      <sect2 role="brk">
         <title>Logical Files Filter Options</title>
 
         <para>You can filter the logIcal files displayed on the Logical Files
@@ -930,9 +949,8 @@
     <sect1 id="Landing_Zones" vendor="eclwatchSS">
       <title>Landing Zones</title>
 
-      <para>The Landing Zone link displays the Landing Zones page. The Landing
-      Zone Page shows you each landing zone you have configured for your
-      cluster and its contents. <figure>
+      <para>The Landing Zone Page shows you each landing zone you have
+      configured for your cluster and its contents. <figure>
           <title>Landing Zone Page</title>
 
           <mediaobject>
@@ -1044,7 +1062,7 @@
           </orderedlist></para>
       </sect2>
 
-      <sect2>
+      <sect2 role="brk">
         <title>Hex Preview</title>
 
         <para>You can view a Hexadecimal representation of files on the
@@ -1118,5 +1136,83 @@
           </orderedlist></para>
       </sect2>
     </sect1>
+
+    <sect1 id="Pub_Query">
+      <title>Published Queries</title>
+
+      <para>The Queries page provides access to published Queries on all
+      clusters in an environment. To access the Queries page click the
+      Published Queries link from the Navigation pane in ECL Watch.</para>
+
+      <sect2>
+        <title>Queries</title>
+
+        <para>Click on any link from the <emphasis
+        role="bold">Targets</emphasis> page to displays that target page. The
+        Target page has two tabs, one for all target queries, and another tab
+        for only active queries. From this page you can get more information
+        about the specific published queries.</para>
+
+        <para><figure>
+            <title>Target Queries</title>
+
+            <mediaobject>
+              <imageobject>
+                <imagedata fileref="../../images/ECLW006.jpg"
+                           vendor="eclwatchSS" />
+              </imageobject>
+            </mediaobject>
+          </figure>Select the queries by clicking on them or shift+click to
+        select multiple queries. Press the buttons for the desired
+        activity.</para>
+
+        <para><variablelist>
+            <varlistentry>
+              <term>Delete</term>
+
+              <listitem>
+                <para>Deletes the selected query (or queries).</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>Toggle Suspend</term>
+
+              <listitem>
+                <para>Toggles between suspending or unsuspending the selected
+                query (or queries).</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>Activate</term>
+
+              <listitem>
+                <para>Activates the selected query (or queries).</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>Query Details</term>
+
+              <listitem>
+                <para>Links to a page with the details for the selected
+                query.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist></para>
+      </sect2>
+    </sect1>
+
+    <sect1 id="Operations">
+      <title>Operations</title>
+
+      <para>The Operations page provides access to several system
+      administrator tasks you can perform on your HPCC system. To access the
+      Operations page click the Operations link from the Navigation pane in
+      ECL Watch.</para>
+
+      <para>More to come...</para>
+    </sect1>
   </chapter>
 </book>