Преглед на файлове

HPCC-14446 DOCS:Add WsECL and ECLWatch to Config book

Fix HPCC-14446 DOCS:Add WsECL and ECLWatch to Config book
Add sections to Config Manager doc to detail the tab and attributes
of the ESP Services, WsECL and ECL Watch.
Fixed Spacing issues and SQUASHED.

Signed-off-by: G Panagiotatos <greg.panagiotatos@lexisnexis.com>
G Panagiotatos преди 9 години
родител
ревизия
b9f3c1e3d7

+ 69 - 0
docs/UsingConfigManager/UsingConfigManager.xml

@@ -1363,6 +1363,75 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
         </sect3>
       </sect2>
 
+      <sect2 id="ESP_Services" role="brk">
+        <title>ESP Services</title>
+
+        <para>ESP Services provide a means to add functionality to an ESP
+        Server.</para>
+
+        <sect3 id="CfgMgrEclWatch">
+          <title>ECL Watch Service</title>
+
+          <para>Ecl Watch allows you to configure options for the ECL Watch
+          utility.</para>
+
+          <para><graphic fileref="images/CM-009.jpg"
+          vendor="configmgrSS" /></para>
+
+          <para>ECL Watch Attribute definitions.</para>
+
+          <!--ECLWa-Include-TBLZ-1-->
+
+          <para><xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
+          xpointer="SMC-T01"
+          xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
+
+          <para>ECL Watch Monitoring attributes.</para>
+
+          <!--ECLWa-Include-TBLZ-2-->
+
+          <para><xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
+          xpointer="SMC-T02"
+          xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
+        </sect3>
+
+        <sect3 id="cfgmgr_WsECL" role="brk">
+          <title>WsECL Service</title>
+
+          <para>The WsECL service allows you to configure options for the
+          WsECL utility.</para>
+
+          <para><graphic fileref="images/CM-010.jpg"
+          vendor="configmgrSS" /></para>
+
+          <para>The Ws ECL configuration attributes. </para>
+
+          <!--WsECL-Include-ZXX-1-->
+	  <para><xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
+	            xpointer="MyWS2-T01"
+          xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
+
+          <para>Ws ECL VIPS option attributes.</para>
+
+          <!--WsECL-Include-ZXX-2-->
+
+          <para><xi:include
+          href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
+          xpointer="MyWS2-T02"
+          xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
+
+          <para>Ws ECL Target Restrictions table. </para>
+
+          <!--WsECL-Include-ZXX-3-->
+	  <para><xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
+	            xpointer="MyWS2-T03"
+          xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
+          
+         
+          
+        </sect3>
+      </sect2>
+
       <sect2 id="FTSlave-Process" role="brk">
         <title>FTSlave Process</title>
 

+ 0 - 1
docs/XMLGeneration/CMakeLists.txt

@@ -24,7 +24,6 @@ FILE(GLOB XSD_TEMPLATE_FILES RELATIVE "${XSD_SOURCE_DIR}" "${XSD_SOURCE_DIR}/*.x
 FILE(GLOB XSD_FILES RELATIVE "${XSD_SOURCE_DIR}" "${XSD_SOURCE_DIR}/*.xsd")
 
 # Skip some files which cause problem
-LIST(REMOVE_ITEM XSD_FILES "esp_service_wsecl2.xsd")
 LIST(REMOVE_ITEM XSD_FILES "ftslave_linux.xsd")
 
 # process and copy *.xsd.in files

BIN
docs/images/CM-009.jpg


BIN
docs/images/CM-010.jpg


+ 23 - 3
initfiles/componentfiles/configxml/esp_service_wsecl.xsd

@@ -25,6 +25,12 @@
             <xs:attributeGroup ref="EclServer"/>
             <xs:attributeGroup ref="Roxie"/>
             <xs:attributeGroup ref="Logging"/>
+              <!--DocAutoBuildCode-->
+                <xs:annotation>
+                 <xs:appinfo>
+                   <docid>MyWS_TbL01</docid>
+                 </xs:appinfo>
+                </xs:annotation> 
             <xs:attribute name="build" type="buildType" use="required">
                 <xs:annotation>
                     <xs:appinfo>
@@ -67,9 +73,11 @@
     </xs:element>
     <xs:attributeGroup name="EclServer">
         <xs:annotation>
-            <xs:appinfo>
-                <title>ECL Server</title>
-            </xs:appinfo>
+           <xs:appinfo>
+              <title>ECL Server</title>
+              <!--DocAutoBuildCode-->
+              <docid>MyWS_TbL02</docid>
+	   </xs:appinfo>
         </xs:annotation>
         <xs:attribute name="eclServer" type="eclServerType" use="optional">
             <xs:annotation>
@@ -137,6 +145,12 @@
         </xs:attribute>
     </xs:attributeGroup>
     <xs:attributeGroup name="Roxie">
+            <!--DocAutoBuildCode-->
+            <xs:annotation>
+	      <xs:appinfo>
+	        <docid>MyWS_TbL04</docid>
+	      </xs:appinfo>
+            </xs:annotation> 
         <xs:attribute name="roxieAddress" type="roxieAddress" use="optional">
             <xs:annotation>
                 <xs:appinfo>
@@ -158,6 +172,12 @@
         </xs:attribute>
     </xs:attributeGroup>
     <xs:attributeGroup name="Logging">
+            <!--DocAutoBuildCode-->
+            <xs:annotation>
+               <xs:appinfo>
+                   <docid>MyWS_TbL05</docid>
+               </xs:appinfo>
+            </xs:annotation> 
         <xs:attribute name="loggingServer" type="xs:string" use="optional">
             <xs:annotation>
                 <xs:appinfo>

+ 19 - 1
initfiles/componentfiles/configxml/esp_service_wsecl2.xsd

@@ -30,7 +30,13 @@
                   </xs:appinfo>
                 </xs:annotation>
                 <xs:complexType>
-                  <xs:attribute name="name" type="xs:string" use="required" default="">
+                <!--DocAutoBuildCode-->
+                    <xs:annotation>
+		       <xs:appinfo>
+		          <docid>MyWS2-T01</docid>
+		       </xs:appinfo>
+		    </xs:annotation>
+           <xs:attribute name="name" type="xs:string" use="required" default="">
                     <xs:annotation>
                       <xs:appinfo>
                         <viewType>hidden</viewType>
@@ -76,6 +82,12 @@
                   </xs:appinfo>
                 </xs:annotation>
                 <xs:complexType>
+                <!--DocAutoBuildCode-->
+                 <xs:annotation>
+	           <xs:appinfo>
+                    <docid>MyWS2-T02</docid>
+	           </xs:appinfo>
+                 </xs:annotation>
                   <xs:attribute name="name" type="topologyClusterType" use="required">
 	                <xs:annotation>
 	                  <xs:appinfo>
@@ -86,6 +98,12 @@
                 </xs:complexType>
               </xs:element>
             </xs:sequence>
+            <!--DocAutoBuildCode-->
+                <xs:annotation>
+	          <xs:appinfo>
+                    <docid>MyWS2-T03</docid>
+	          </xs:appinfo>
+	        </xs:annotation>
             <xs:attribute name="build" type="buildType" use="required">
                 <xs:annotation>
                     <xs:appinfo>

+ 12 - 0
initfiles/componentfiles/configxml/espsmcservice.xsd.in

@@ -48,6 +48,12 @@
                     </xs:appinfo>
                 </xs:annotation>
             </xs:attribute>
+                <xs:annotation>
+	          <xs:appinfo>
+	          <!--DOCS_Autobuild_Code-->
+          	    <docid>SMC-T01</docid>
+	          </xs:appinfo>
+              </xs:annotation>
             <xs:attribute name="description" type="xs:string" use="optional" default="ESP services for SMC">
                 <xs:annotation>
                     <xs:appinfo>
@@ -150,6 +156,12 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="Monitoring">
+         <xs:annotation>
+	    <xs:appinfo>
+            <!--DOCS_Autobuild_Code-->
+              <docid>SMC-T02</docid>
+            </xs:appinfo>
+         </xs:annotation> s	
         <xs:attribute name="monitorDaliFileServer" type="xs:boolean" use="optional" default="false">
             <xs:annotation>
                 <xs:appinfo>