Merge pull request #10518 from JamesDeFabia/HPCC-18374Document_ecl_Zapgen

HPCC-18374 Document ecl zapgen

Reviewed-By: Attila Vamos <attila.vamos@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/HPCCClientTools/CT_Mods/CT_ECL_CLI.xml

@@ -2060,7 +2060,7 @@ ecl queries recreate roxie findpeople roxie2</programlisting>
                 </row>
 
                 <row>
-                  <entry>-A-, --no-activate </entry>
+                  <entry>-A-, --no-activate</entry>
 
                   <entry>Does not activate query when published</entry>
                 </row>
@@ -4604,6 +4604,108 @@ ecl getname -wu W201407*
             </tgroup>
           </informaltable></para>
       </sect2>
+
+      <sect2 id="CT_CLI_SyntaxECLzapgen" role="brk">
+        <title>ecl zapgen</title>
+
+        <para><emphasis role="bold">ecl zapgen &lt;WUID&gt; --path
+        &lt;zap_file_path&gt; [options]</emphasis></para>
+
+        <para>Use the zapgen command to create a Zipped Analysis Package
+        (Z.A.P.) containing collecting system information about a workunit and
+        encapsulating it into a shareable package. It is a useful tool for
+        reporting errors, inconsistencies, or other unexpected behavior.
+        </para>
+
+        <para>Examples:</para>
+
+        <programlisting>ecl zapgen W20171017-091320 --path ~/reports
+ecl zapgen W20171018-091399 --path ~ --inc-thor-slave-logs --description "Unexpected result from JOIN"
+</programlisting>
+
+        <para><informaltable colsep="1" frame="all" rowsep="1">
+            <tgroup cols="2">
+              <colspec align="left" colwidth="125.55pt" />
+
+              <colspec colwidth="384.85pt" />
+
+              <tbody>
+                <row>
+                  <entry>ecl zapgen</entry>
+
+                  <entry>Creates a ZAP file for the given workunit in the
+                  specified path.</entry>
+                </row>
+
+                <row>
+                  <entry>WUID</entry>
+
+                  <entry>The WUID (Workunit ID)</entry>
+                </row>
+
+                <row>
+                  <entry>--path</entry>
+
+                  <entry>The path to store the ZAP file</entry>
+                </row>
+
+                <row>
+                  <entry><emphasis role="bold">Options</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>--inc-thor-slave-logs</entry>
+
+                  <entry>Includes Thor slave(s) log into the ZAP file</entry>
+                </row>
+
+                <row>
+                  <entry>--description</entry>
+
+                  <entry>Description of the issue</entry>
+                </row>
+
+                <row>
+                  <entry>-v, --verbose</entry>
+
+                  <entry>Output additional tracing information</entry>
+                </row>
+
+                <row>
+                  <entry>-s, --server</entry>
+
+                  <entry>The IP Address or hostname of ESP server running ECL
+                  Watch services</entry>
+                </row>
+
+                <row>
+                  <entry>-ssl,--ssl</entry>
+
+                  <entry>Use SSL to secure the connection to the
+                  server.</entry>
+                </row>
+
+                <row>
+                  <entry>--port</entry>
+
+                  <entry>The ECL Watch services port (Default is 8010)</entry>
+                </row>
+
+                <row>
+                  <entry>-u, --username</entry>
+
+                  <entry>The username (if necessary)</entry>
+                </row>
+
+                <row>
+                  <entry>-pw, --password</entry>
+
+                  <entry>The password (if necessary)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </informaltable></para>
+      </sect2>
     </sect1>
   </chapter>
 </book>