Merge pull request #188 from electric-cloud/update-doc

Docs

help/changelog.yaml

@@ -1,7 +1,12 @@
 3.4.0:
-  - Updated support for Datasources by adding the procedure CreateOrUpdateDatasource. The old procedure CreateDatasource is now deprecated.
-  - Updated procedure DeleteDatasource
-  - Added "Discover" feature, now EF Model can be created from already existing WebLogic setup.
+  - |
+    Introduced the following 2 new procedures
+    <ul>
+    <li>"CreateorUpdateDataSource" to support Data Source management.</li>
+    <li>"Discover" procedure to support the discovery functionality where in an EF model can be created from an existing Weblogic environment.</li>
+    </ul>
+  - Modified DeleteDataSource procedure
+  - Old procedure CreateDataSource is deprecated
 3.3.0:
   - |
     Added support for JMS Resource Management by adding the following procedures:

help/procedures/CreateConfiguration/preface.md

@@ -1,3 +1,5 @@
+**After you perform the setup below it is important to make sure that the Electric Flow agent machine on which WebLogic runs is registered as a resource that can be pinged.**
+
 <img src="../../plugins/EC-WebLogic/images/Config/EC-WLSConfig.png" />
 
 **Note:** In the URL, the protocol is "t3" or "t3s". The
@@ -8,3 +10,5 @@ other WebLogic Server instances. A server instance
 keeps track of each Java Virtual Machine (JVM) with
 which it connects, and creates a single "t3" connection
 to carry all traffic for a JVM.
+
+

help/procedures/Discover/preface.md

@@ -1,15 +1,11 @@
-This procedure will discover WebLogic resources and create a configuration, resource and EF model based on your current WebLogic resources.
+After the procedure runs the following are created:
 
-Upon run, the procedure will create:
-
-* A configuration for EC-WebLogic plugin, based on provided and discovered data.
+* A EC-WebLogic plugin configuration based on the discovered environment
 * An EF Resource and Environment, based on the provided resource/hostname data.
-* An Application with the components and process steps based on WebLogic resources, if Object Names are provided.
-
-Every run will also create several reports in csv, JSON and HTML format, which will describe the current state of WebLogic resources.
-
+* An Application with components and process steps based on WebLogic resources, based on Object Names provided.
+* A report describing the current state of Weblogic resources in a variety of formats (csv, JSON and HTML).
 
-The following resources can be discovered:
+Currently the following objects are supported for discovery:
 
 * AppDeployment
 * Library
@@ -22,7 +18,5 @@ The following resources can be discovered:
 * JMS Server
 * Server
 * Cluster
-
-
-User
-Group
+* User
+* Group

pages/EC-WebLogic_help.xml

@@ -14,7 +14,7 @@
     <h1>@PLUGIN_KEY@</h1>
     <p>Plugin version @PLUGIN_VERSION@</p>
 
-    <p>Revised on August 30, 2018</p>
+    <p>Revised on August 31, 2018</p>
 
     <hr style="margin-left: -10px; margin-top: 10px; height: 1px; width: 100%; color: #5981BD;" noshade="noshade"/>
     <h3>Overview</h3>
@@ -89,7 +89,8 @@ or to enter a new embedded file.</p>
              Configurations page.</li>
         <li>Click <b>Create Configuration</b>.</li>
 
-        <img src="../../plugins/EC-WebLogic/images/Config/EC-WLSConfig.png" />
+        <p><strong>After you perform the setup below it is important to make sure that the Electric Flow agent machine on which WebLogic runs is registered as a resource that can be pinged.</strong></p>
+<img src="../../plugins/EC-WebLogic/images/Config/EC-WLSConfig.png" />
 <p><strong>Note:</strong> In the URL, the protocol is &quot;t3&quot; or &quot;t3s&quot;. The
 RMI communications in WebLogic Server use
 the &quot;t3&quot; protocol to transport data between WebLogic
@@ -98,7 +99,6 @@ other WebLogic Server instances. A server instance
 keeps track of each Java Virtual Machine (JVM) with
 which it connects, and creates a single &quot;t3&quot; connection
 to carry all traffic for a JVM.</p>
-<p><strong>After you perform the setup below it is important to make sure that the Electric Flow agent machine on which WebLogic runs is registered as a resource that can be pinged.</strong></p>
 
 
         Configuration Parameters
@@ -143,7 +143,7 @@ to carry all traffic for a JVM.</p>
 
             <tr>
                 <td >Login as</td>
-                <td></td>
+                <td>Username and password to connect to WebLogic server.</td>
             </tr>
 
             <tr>
@@ -1787,10 +1787,7 @@ successfully.</p>
     <div id="CreateOrUpdateDatasource">
         <h2>CreateOrUpdateDatasource</h2>
 
-        <p>Creates or updates a Datasource</p>
-
-            <p>This procedure is used to create a new generic JDBC datasource or update an existing one.</p>
-
+        <p>This procedure creates a new generic JDBC Data Source or updates an existing one based on the update action.</p>
 
         <h3>CreateOrUpdateDatasource Parameters</h3>
         <table class="grid">
@@ -1853,13 +1850,13 @@ By default, the JNDI name is the name of the Datasource. Applications that look
 
             <tr>
                 <td >Update Action</td>
-                <td>This parameter controls as to what the Update Action should be when a JMS Queue with the same name exists:<br/><b>Do Nothing (Default)</b> - The procedure will take no action upon an update (i.e., will be a NO-OP), if this option is chosen.<br/><b>Remove and Create</b> - The procedure would remove existing JMS Queue and recreate it based on new parameters passed.<br/><b>Selective Update</b> - The procedure would update existing DataSource credentials and Server Target List.
+                <td>This parameter controls as to what the Update Action should be when a DataSource with the same name exists:<br/><b>Do Nothing (Default)</b> - The procedure will take no action upon an update (i.e., will be a NO-OP), if this option is chosen.<br/><b>Remove and Create</b> - The procedure would remove existing DataSource and recreate it based on new parameters passed.<br/><b>Selective Update</b> - The procedure would update existing DataSource credentials and Server Target List.
 </td>
             </tr>
 
             <tr>
                 <td >Additional Options</td>
-                <td>Use this option to specify optional parameters for example initial pool size, min pool size, max pool size, validation SQL etc., At a minimum we should show case and test the validation SQL and pool size, going against MariaDB or MySQL.</td>
+                <td>Use this option to specify optional parameters for example initial pool size, min pool size, max pool size, validation SQL etc.</td>
             </tr>
 
             </tbody>
@@ -4266,17 +4263,16 @@ control statements.</p>
     <div id="Discover">
         <h2>Discover</h2>
 
-        <p>Discovers WebLogic configuration and deployable objects</p>
+        <p>This procedure connects to a Weblogic environment, discovers objects specified by user and creates a Weblogic plugin configuration and an Application/Environment model in Electric Flow based on objects discovered.</p>
 
-            <p>This procedure will discover WebLogic resources and create a configuration, resource and EF model based on your current WebLogic resources.</p>
-<p>Upon run, the procedure will create:</p>
+            <p>After the procedure runs the following are created:</p>
 <ul>
-<li>A configuration for EC-WebLogic plugin, based on provided and discovered data.</li>
+<li>A EC-WebLogic plugin configuration based on the discovered environment</li>
 <li>An EF Resource and Environment, based on the provided resource/hostname data.</li>
-<li>An Application with the components and process steps based on WebLogic resources, if Object Names are provided.</li>
+<li>An Application with components and process steps based on WebLogic resources, based on Object Names provided.</li>
+<li>A report describing the current state of Weblogic resources in a variety of formats (csv, JSON and HTML).</li>
 </ul>
-<p>Every run will also create several reports in csv, JSON and HTML format, which will describe the current state of WebLogic resources.</p>
-<p>The following resources can be discovered:</p>
+<p>Currently the following objects are supported for discovery:</p>
 <ul>
 <li>AppDeployment</li>
 <li>Library</li>
@@ -4289,9 +4285,9 @@ control statements.</p>
 <li>JMS Server</li>
 <li>Server</li>
 <li>Cluster</li>
+<li>User</li>
+<li>Group</li>
 </ul>
-<p>User
-Group</p>
 
 
         <h3>Discover Parameters</h3>
@@ -4306,7 +4302,7 @@ Group</p>
 
             <tr>
                 <td >Resource Name</td>
-                <td>Name of the ElectricFlow resource with the WebLogic instance running.</td>
+                <td>Name of the ElectricFlow resource that represents the WebLogic environment that needs to be discovered.</td>
             </tr>
 
             <tr>
@@ -4321,12 +4317,12 @@ Group</p>
 
             <tr>
                 <td >Oracle Home</td>
-                <td>Installation path of the WebLogic server, e.g. /home/oracle. Either this parameter or WLST Path parameter must be specified.</td>
+                <td>Installation path of the WebLogic server, e.g. /home/oracle. Not required if WLST Path parameter is specified.</td>
             </tr>
 
             <tr>
                 <td >WLST Path</td>
-                <td>Path to wlst.sh utility. If not provided, the procedure will look for it in known locations. Either this parameter or Oracle Home parameter must be specified.</td>
+                <td>Absolute Path to WLST utility. If not provided, the procedure will look for it, in known locations. Not required if Oracle Home is specified.</td>
             </tr>
 
             <tr>
@@ -4346,7 +4342,7 @@ Group</p>
 
             <tr>
                 <td >Environment Project Name</td>
-                <td>If specified, will be used to create ElectricFlow environment.</td>
+                <td>If specified will create Project for the Environment.</td>
             </tr>
 
             <tr>
@@ -4356,25 +4352,22 @@ Group</p>
 
             <tr>
                 <td >Application Project Name</td>
-                <td>Project name to create Application based on discovered entities.</td>
+                <td>Project name to create Application based on discovered objects.</td>
             </tr>
 
             <tr>
                 <td >Application Name</td>
-                <td>Application for placing discovered entities.</td>
+                <td>Application for placing discovered objects.</td>
             </tr>
 
             <tr>
                 <td >Object Names</td>
-                <td>Objects to be retrieved from the WL Server in type:name pairs, e.g. AppDeployment:HelloWorld.
-
+                <td>Objects to be retrieved from the WL Server in type:name pairs, e.g. AppDeployment:HelloWorld. For JMS Resource the name of the resource should be prefixed by JMS Module Name: helloJMSModule:helloQueue.
+<br/>
+The list of Object Names can be found in the .csv report generated by this procedure.
 <br/>
 The list of supported object types:
-<br/><ul><li>AppDeployment</li><li>Library</li><li>Server</li><li>Cluster</li><li>Datasource</li><li>Queue</li><li>Topic</li><li>JMSResource</li><li>JMSServer</li><li>ConnectionFactory</li><li>User</li><li>Group</li></ul>
-
-For JMS Resource the name of the resource should be prefixed by JMS Module Name: <b>helloJMSModule:helloQueue</b><br/>
-The list of Object Names can be taken from the .csv report generated by this procedure.
-</td>
+<ul><li>AppDeployment</li><li>Library</li><li>Server</li><li>Cluster</li><li>Datasource</li><li>Queue</li><li>Topic</li><li>JMSResource</li><li>JMSServer</li><li>ConnectionFactory</li><li>User</li><li>Group</li></ul></td>
             </tr>
 
             </tbody>
@@ -4410,11 +4403,16 @@ The list of Object Names can be taken from the .csv report generated by this pro
     <h3>@PLUGIN_KEY@ 3.4.0</h3>
     <ul>
 
-        <li>Updated support for Datasources by adding the procedure CreateOrUpdateDatasource. The old procedure CreateDatasource is now deprecated.</li>
+        <li>Introduced the following 2 new procedures
+<ul>
+<li>"CreateorUpdateDataSource" to support Data Source management.</li>
+<li>"Discover" procedure to support the discovery functionality where in an EF model can be created from an existing Weblogic environment.</li>
+</ul>
+</li>
 
-        <li>Updated procedure DeleteDatasource</li>
+        <li>Modified DeleteDataSource procedure</li>
 
-        <li>Added "Discover" feature, now EF Model can be created from already existing WebLogic setup.</li>
+        <li>Old procedure CreateDataSource is deprecated</li>
 
     </ul>
 

src/main/resources/project/WebLogicCreateConfigForm.xml

@@ -69,6 +69,7 @@ limitations under the License.
         <property>credential</property>
         <value></value>
         <required>0</required>
+        <documentation>Username and password to connect to WebLogic server.</documentation>
     </formElement>
     <formElement>
         <type>checkbox</type>

src/main/resources/project/ec_setup.pl

@@ -272,7 +272,7 @@
 my %createOrUpdateDatasource = (
     label       => "WebLogic - Create Or Update Datasource",
     procedure   => "CreateOrUpdateDatasource",
-    description => "Create or update datasource",
+    description => "This procedure creates a new generic JDBC Data Source or updates an existing one based on the update action.",
     category    => "Application Server"
 );
 

src/main/resources/project/parameterForms/ec_parameterForm-CreateOrUpdateDataSource.xml

@@ -94,9 +94,9 @@ By default, the JNDI name is the name of the Datasource. Applications that look
     <type>select</type>
     <label>Update Action:</label>
     <property>ecp_weblogic_updateAction</property>
-    <htmlDocumentation>This parameter controls as to what the Update Action should be when a JMS Queue with the same name exists:<br/>
+    <htmlDocumentation>This parameter controls as to what the Update Action should be when a DataSource with the same name exists:<br/>
 <b>Do Nothing (Default)</b> - The procedure will take no action upon an update (i.e., will be a NO-OP), if this option is chosen.<br/>
-<b>Remove and Create</b> - The procedure would remove existing JMS Queue and recreate it based on new parameters passed.<br/>
+<b>Remove and Create</b> - The procedure would remove existing DataSource and recreate it based on new parameters passed.<br/>
 <b>Selective Update</b> - The procedure would update existing DataSource credentials and Server Target List.
 </htmlDocumentation>
     <required>0</required>
@@ -118,7 +118,7 @@ By default, the JNDI name is the name of the Datasource. Applications that look
     <type>textarea</type>
     <label>Additional Options:</label>
     <property>ecp_weblogic_additionalOptions</property>
-    <documentation>Use this option to specify optional parameters for example initial pool size, min pool size, max pool size, validation SQL etc., At a minimum we should show case and test the validation SQL and pool size, going against MariaDB or MySQL.</documentation>
+    <documentation>Use this option to specify optional parameters for example initial pool size, min pool size, max pool size, validation SQL etc.</documentation>
     <required>0</required>
 </formElement>
 </editor>

src/main/resources/project/parameterForms/ec_parameterForm-Discover.xml

@@ -22,7 +22,7 @@
         <label>Resource Name:</label>
         <property>ecp_weblogic_resourceName</property>
         <required>0</required>
-        <documentation>Name of the ElectricFlow resource with the WebLogic instance running.</documentation>
+        <documentation>Name of the ElectricFlow resource that represents the WebLogic environment that needs to be discovered.</documentation>
     </formElement>
     <formElement>
         <type>entry</type>
@@ -43,14 +43,14 @@
         <label>Oracle Home:</label>
         <property>ecp_weblogic_oracleHome</property>
         <required>0</required>
-        <documentation>Installation path of the WebLogic server, e.g. /home/oracle. Either this parameter or WLST Path parameter must be specified.</documentation>
+        <documentation>Installation path of the WebLogic server, e.g. /home/oracle. Not required if WLST Path parameter is specified.</documentation>
     </formElement>
     <formElement>
         <type>entry</type>
         <label>WLST Path:</label>
         <property>ecp_weblogic_wlstPath</property>
         <required>0</required>
-        <documentation>Path to wlst.sh utility. If not provided, the procedure will look for it in known locations. Either this parameter or Oracle Home parameter must be specified.</documentation>
+        <documentation>Absolute Path to WLST utility. If not provided, the procedure will look for it, in known locations. Not required if Oracle Home is specified.</documentation>
     </formElement>
     <formElement>
         <type>entry</type>
@@ -88,7 +88,7 @@
         <label>Environment Project Name:</label>
         <property>ecp_weblogic_envProjectName</property>
         <required>0</required>
-        <documentation>If specified, will be used to create ElectricFlow environment.</documentation>
+        <documentation>If specified will create Project for the Environment.</documentation>
     </formElement>
     <formElement>
         <type>entry</type>
@@ -102,43 +102,40 @@
         <label>Application Project Name:</label>
         <property>ecp_weblogic_appProjName</property>
         <required>0</required>
-        <documentation>Project name to create Application based on discovered entities.</documentation>
+        <documentation>Project name to create Application based on discovered objects.</documentation>
     </formElement>
     <formElement>
         <type>entry</type>
         <label>Application Name:</label>
         <property>ecp_weblogic_appName</property>
         <required>0</required>
-        <documentation>Application for placing discovered entities.</documentation>
+        <documentation>Application for placing discovered objects.</documentation>
     </formElement>
     <formElement>
         <type>textarea</type>
         <label>Object Names:</label>
         <property>ecp_weblogic_objectNames</property>
         <required>0</required>
-        <htmlDocumentation>Objects to be retrieved from the WL Server in type:name pairs, e.g. AppDeployment:HelloWorld.
-
+        <htmlDocumentation>Objects to be retrieved from the WL Server in type:name pairs, e.g. AppDeployment:HelloWorld. For JMS Resource the name of the resource should be prefixed by JMS Module Name: helloJMSModule:helloQueue.
 <br/>
-The list of supported object types:
+The list of Object Names can be found in the .csv report generated by this procedure.
 <br/>
+The list of supported object types:
 <ul>
-<li>AppDeployment</li>
-<li>Library</li>
-<li>Server</li>
-<li>Cluster</li>
-<li>Datasource</li>
-<li>Queue</li>
-<li>Topic</li>
-<li>JMSResource</li>
-<li>JMSServer</li>
-<li>ConnectionFactory</li>
-<li>User</li>
-<li>Group</li>
+    <li>AppDeployment</li>
+    <li>Library</li>
+    <li>Server</li>
+    <li>Cluster</li>
+    <li>Datasource</li>
+    <li>Queue</li>
+    <li>Topic</li>
+    <li>JMSResource</li>
+    <li>JMSServer</li>
+    <li>ConnectionFactory</li>
+    <li>User</li>
+    <li>Group</li>
 </ul>
 
-For JMS Resource the name of the resource should be prefixed by JMS Module Name: <b>helloJMSModule:helloQueue</b>
-<br/>
-The list of Object Names can be taken from the .csv report generated by this procedure.
 </htmlDocumentation>
     </formElement>
 </editor>