This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hop.git
The following commit(s) were added to refs/heads/master by this push:
new 92911f2 HOP-3267 action docs cleanup and descriptions a-m
new 51f394b Merge pull request #1168 from bamaer/HOP-3267
92911f2 is described below
commit 92911f26b7a89d0e5fa989c59fee2b5dcda36109
Author: Bart Maertens <[email protected]>
AuthorDate: Fri Oct 22 20:59:17 2021 +0200
HOP-3267 action docs cleanup and descriptions a-m
---
.../modules/ROOT/pages/workflow/actions/abort.adoc | 3 ++-
.../ROOT/pages/workflow/actions/addresultfilenames.adoc | 6 ++++--
.../modules/ROOT/pages/workflow/actions/as400command.adoc | 3 ++-
.../ROOT/pages/workflow/actions/cassandra-exec-cql.adoc | 7 +++++--
.../ROOT/pages/workflow/actions/checkdbconnection.adoc | 3 ++-
.../ROOT/pages/workflow/actions/checkfilelocked.adoc | 4 +++-
.../modules/ROOT/pages/workflow/actions/columnsexist.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/copyfiles.adoc | 3 ++-
.../pages/workflow/actions/copymoveresultfilenames.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/createfile.adoc | 4 ++--
.../modules/ROOT/pages/workflow/actions/createfolder.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/delay.adoc | 5 +++--
.../modules/ROOT/pages/workflow/actions/deletefile.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/deletefiles.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/deletefolders.adoc | 3 ++-
.../ROOT/pages/workflow/actions/deleteresultfilenames.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/dostounix.adoc | 6 ++++--
.../modules/ROOT/pages/workflow/actions/dtdvalidator.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/dummy.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/eval.adoc | 6 +++++-
.../ROOT/pages/workflow/actions/evalfilesmetrics.adoc | 1 +
.../ROOT/pages/workflow/actions/evaluatetablecontent.adoc | 5 +++--
.../modules/ROOT/pages/workflow/actions/filecompare.adoc | 4 +++-
.../modules/ROOT/pages/workflow/actions/fileexists.adoc | 13 +++++++++++--
.../modules/ROOT/pages/workflow/actions/filesexist.adoc | 5 +++--
.../modules/ROOT/pages/workflow/actions/folderisempty.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/folderscompare.adoc | 1 +
.../modules/ROOT/pages/workflow/actions/ftp.adoc | 6 +++++-
.../modules/ROOT/pages/workflow/actions/ftpdelete.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/ftpput.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/getpop.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/http.adoc | 10 ++++++++--
.../modules/ROOT/pages/workflow/actions/mail.adoc | 11 +++++++++--
.../modules/ROOT/pages/workflow/actions/mailvalidator.adoc | 2 ++
.../modules/ROOT/pages/workflow/actions/movefiles.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/msgboxinfo.adoc | 7 ++++---
.../modules/ROOT/pages/workflow/actions/mssqlbulkload.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/mysqlbulkfile.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/mysqlbulkload.adoc | 1 +
39 files changed, 117 insertions(+), 47 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/abort.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/abort.adoc
index 96b1bc0..cb48cfa 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/abort.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/abort.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Abort action immediately stops (aborts) a running workflow.
= Abort
== Description
-Use this action if you want to abort a workflow.
+The Abort action immediately stops (aborts) a running workflow.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/addresultfilenames.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/addresultfilenames.adoc
index 8228489..da757aa 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/addresultfilenames.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/addresultfilenames.adoc
@@ -16,13 +16,15 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Add Filenames To Result action adds a set of files or
folders to the result list of the workflow action.
= Add filenames to result
== Description
-This workflow action allows you to add a set of files or folders to the result
list of the workflow action.
-That list of filenames can then be used in the various workflow actions all
around.
+The Add Filenames To Result action adds a set of files or folders to the
result list of the workflow action.
+
+This list of filenames can then be used in the various workflow actions all
around.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
index 8c164c8..34ba184 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The AS/400 Command action executes an AS/400 CL Commands.
= AS/400 Command
== Description
-This action is for executing a AS/400 CL Commands.
+The AS/400 Command action executes an AS/400 CL Commands.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/cassandra-exec-cql.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/cassandra-exec-cql.adoc
index 6486f1c..d4bcfaa 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/cassandra-exec-cql.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/cassandra-exec-cql.adoc
@@ -16,14 +16,17 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Cassandra Exec CQL action executes one or more CassandraQL
statements on a Cassandra cluster.
:openvar: ${
:closevar: }
= Cassandra Exec CQL
-This action allows you to execute one or more CassandraQL statements on a
Cassandra cluster.
-You can use it to create or drop keyspaces, tables, indexes and so on.
+The Cassandra Exec CQL action executes one or more CassandraQL statements on a
Cassandra cluster.
+
+You can use it to create or drop key spaces, tables, indexes and so on.
+
If all statements executed successfully the result will be true (success).
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkdbconnection.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkdbconnection.adoc
index 5b072a1..35a61a4 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkdbconnection.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkdbconnection.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Check DB Connections workflow action verifies connectivity
with one or several databases.
= Check Db connections
== Description
-This workflow action allows you to verify connectivity with one or several
databases.
+The Check DB Connections workflow action verifies connectivity with one or
several databases.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkfilelocked.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkfilelocked.adoc
index 8f3a8ac..bdc02f5 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkfilelocked.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/checkfilelocked.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Check Files Locked action loops over a list of files to
check if they are locked by another process.
= Check Files Locked
== Description
-This workflow action goes over a list of files to see that if they are locked
by another process.
+The Check Files Locked action loops over a list of files to check if they are
locked by another process.
+
The way that it verified is by renaming a file to the same name as before.
On certain operating systems (MS Windows systems in particular) this operation
will fail if the file is locked.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/columnsexist.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/columnsexist.adoc
index 8a42d3d..75c69c8 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/columnsexist.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/columnsexist.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Columns Exist In A Table action verifies that one or more
columns exist in a database table.
= Columns exist in a table
== Description
-This workflow action verifies that one or more columns exist in a database
table.
+The Columns Exist In A Table action verifies that one or more columns exist in
a database table.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copyfiles.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copyfiles.adoc
index 68c6c4e..cff0897 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copyfiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copyfiles.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Copy Files action copies one of more files or folders.
= Copy Files
== Description
-This workflow action copies one of more files or folders.
+The Copy Files action copies one of more files or folders.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copymoveresultfilenames.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copymoveresultfilenames.adoc
index 9bf6bbc..558021b 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copymoveresultfilenames.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/copymoveresultfilenames.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Copy Or Move Files From Result action allows you to copy,
move or delete a number of files and/or folders to alternate locations on your
file system.
= Copy Or Move Files from result
== Description
-This workflow action allows you to copy, move or delete a number of files
and/or folders to alternate locations on your file system.
+The Copy Or Move Files From Result action allows you to copy, move or delete a
number of files and/or folders to alternate locations on your file system.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfile.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfile.adoc
index 3c5e7ee..33ac621 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfile.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfile.adoc
@@ -16,13 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Create File action creates an empty file. This is useful for
creating trigger files from within workflows.
= Create File
== Description
-You can use the Create a file action to create an empty file.
-This is useful for creating "trigger" files from within workflows.
+The Create File action creates an empty file. This is useful for creating
trigger files from within workflows.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfolder.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfolder.adoc
index 144510f..9ef3198 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfolder.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/createfolder.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Create Folder action creates a folder at the specified
location.
= Create Folder
== Description
-This workflow action simply creates a folder at the specified location.
+The Create Folder action creates a folder at the specified location.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/delay.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/delay.adoc
index 60382e5..98dac86 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/delay.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/delay.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Delay (Wait For) action creates a delay between workflows.
-= Delay
+= Delay (Wait For)
== Description
-This workflow action creates a delay between workflows.
+The Delay (Wait For) action creates a delay between workflows.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefile.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefile.adoc
index e431b1b..5163b73 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefile.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefile.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Delete File action deletes a file (empty or not).
= Delete File
== Description
-This workflow action deletes a file (empty or not).
+The Delete File action deletes a file (empty or not).
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefiles.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefiles.adoc
index 5058eb6..477b8b4 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefiles.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Delete Files action deletes a set of files.
= Delete Files
== Description
-This workflow action deletes a set of files.
+The Delete Files action deletes a set of files.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefolders.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefolders.adoc
index 72b92d0..aa3d8d2 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefolders.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deletefolders.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Delete Folders action deletes a set of folders and their
content.
= Delete Folders
== Description
-This workflow action deletes a set of folders and their content.
+The Delete Folders action deletes a set of folders and their content.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
index 9312d22..dd6ed3b 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Delete Filenames From Result action deletes all the
filenames that are in the result files list of the last workflow action.
= Delete filenames from result
== Description
-Use this action to delete all the filenames that are in the result files list
of the last workflow action.
+The Delete Filenames From Result action deletes all the filenames that are in
the result files list of the last workflow action.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dostounix.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dostounix.adoc
index ee8181a..07e3e2d 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dostounix.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dostounix.adoc
@@ -16,13 +16,15 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The DOS To Unix action converts files from Windows (DOS) Format
(lines end with CR/LF) to Linux/Unix Format (lines end with LF) and vice versa.
= Dos To Unix
== Description
-Convert files from Windows (DOS) Format (lines end with CR/LF) to Linux/Unix
Format (lines end with LF) and vice versa.
-When the format is unknown, it has also a guess function and converts to the
other format.
+The DOS To Unix action converts files from Windows (DOS) Format (lines end
with CR/LF) to Linux/Unix Format (lines end with LF) and vice versa.
+
+When the format is unknown, this action also has a guess function and converts
to the other format.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dtdvalidator.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dtdvalidator.adoc
index 1c3b3b6..36f3e31 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dtdvalidator.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dtdvalidator.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The DTD Validator action verifies if an XML file corresponds to
a certain structure or format according to a Document Type Definition or DTD.
= DTD Validator
== Description
-The DTD Validator action allows you to verify if an XML file corresponds to a
certain structure or format according to a Document Type Definition or
link:http://en.wikipedia.org/wiki/Document_Type_Definition[DTD].
+The DTD Validator action verifies if an XML file corresponds to a certain
structure or format according to a Document Type Definition or
link:http://en.wikipedia.org/wiki/Document_Type_Definition[DTD].
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dummy.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dummy.adoc
index 6d883cf..acdc70b 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dummy.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/dummy.adoc
@@ -16,9 +16,10 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Dummy action does not add any functionality, but can be
useful as a placeholder action or as a workflow layout helper.
= Dummy
== Description
-The Dummy action does nothing.
+The Dummy action does not add any functionality, but can be useful as a
placeholder action or as a workflow layout helper.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/eval.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/eval.adoc
index ccfe2d4..78b78d1 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/eval.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/eval.adoc
@@ -16,14 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The JavaScript action runs Javascript code and returns a boolean
expression.
= JavaScript
== Description
-Use the JavaScript action to calculate a boolean expression.
+The JavaScript action runs Javascript code and returns a boolean expression.
+
The result can be used to determine which action will be executed next.
+
You can use functions, procedure calls, ANDs, ampersands, ORs, EQUALs, etc.
+
The Javascript workflow action evaluates and returns a true or false.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evalfilesmetrics.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evalfilesmetrics.adoc
index e272f55..a0fb11d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evalfilesmetrics.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evalfilesmetrics.adoc
@@ -16,6 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Evaluate File Metrics action can be used to evaluate the
size or count of files.
= Evaluate File Metrics
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evaluatetablecontent.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evaluatetablecontent.adoc
index 6499833..c2675ce 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evaluatetablecontent.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/evaluatetablecontent.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Evaluate Row Numbers In A Table action you can define the
success condition that can be evaluated and branch the workflow process by the
result.
-= Evaluate rows number in a table
+= Evaluate row numbers in a table
== Description
-With this workflow action you can define the success condition that can be
evaluated and branch the workflow process by the result.
+The Evaluate Row Numbers In A Table action you can define the success
condition that can be evaluated and branch the workflow process by the result.
You can either just test the number of rows in a target table, or write a
custom SQL statement.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filecompare.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filecompare.adoc
index e91f8a7..746b80b 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filecompare.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filecompare.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The File Compare workflow action compares the contents of 2
files. It returns true if the files are equal, false if different.
= File compare
== Description
-You can use the File compare workflow action to compare the contents of 2
files and control the flow of the workflow by it.
+The File Compare workflow action compares the contents of 2 files. It returns
true if the files are equal, false if different.
+
When the contents of the files are the same the success outgoing hop will be
followed, else the failure hop will be followed.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/fileexists.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/fileexists.adoc
index abf1aa7..294a546 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/fileexists.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/fileexists.adoc
@@ -16,19 +16,28 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The File Exists action verifies that a specified file exists on
the server on which Hop is running.
= File Exists
== Description
-Use the File exists action to verify that a specified file exists on the
server on which Hop is running.
+The File Exists action verifies that a specified file exists on the server on
which Hop is running.
+
You must provide the file name.
-Hop returns a True or False value depending on whether or not the file exists.
+
+Hop returns a True or False value depending on whether the file exists.
+
The File Exists workflow action can be an easy integration point with other
systems.
+
For example, suppose you have a three-part data warehouse load process.
+
The first part runs in PERL.
+
You have batch scripts that accesses data from a remote location, performs
first-level row processing, and outputs the data to a specified directory.
+
You do not want to start the workflow until this is done, so you put the
workflow on a scheduler.
+
As soon as the task is complete, the file is placed in a well-known location
so that the "file exists." That is the signal that launches the workflow for
final processing.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filesexist.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filesexist.adoc
index fe53525..3a698e4 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filesexist.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/filesexist.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Checks If Files Exist action verifies that the specified
files exist. The action returns true if the files exist, false if they don't.
-= Checks if files exists
+= Checks if files exist
== Description
-Use the Checks if files exists action to verify that specified files exist.
+The Checks If Files Exist action verifies that the specified files exist. The
action returns true if the files exist, false if they don't.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderisempty.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderisempty.adoc
index 7583e22..a9ccfb9 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderisempty.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderisempty.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Folder Is Empty action verifies if a folder is empty, that
there are no regular files or sub-folders in the folder.
= Folder is Empty
== Description
-The Folder is empty action verifies if a folder is empty, that there are no
regular files or sub-folders in the folder.
+The Folder Is Empty action verifies if a folder is empty, that there are no
regular files or sub-folders in the folder.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderscompare.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderscompare.adoc
index 535ed86..d0da07d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderscompare.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/folderscompare.adoc
@@ -16,6 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Folders Compare action compares two folders to determine if
the content is identical; the result will either be true or false.
= Folders Compare
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftp.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftp.adoc
index 34cfe18..8310ddf 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftp.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftp.adoc
@@ -16,14 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Get A File With FTP action retrieves one or more files from
an FTP server.
= Get a file with FTP
== Description
-Use the Get a File with FTP workflow action to retrieve one or more files from
an FTP server.
+The Get A File With FTP action retrieves one or more files from an FTP server.
+
This workflow action does not "crawl" systems.
+
It will not, for example, access a remote directory and go to other
directories to find files that match a wildcard.
+
This workflow retrieves files from one directory exclusively.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpdelete.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpdelete.adoc
index f08039b..8baa96a 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpdelete.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpdelete.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The FTP delete action deletes files on an FTP server.
= FTP delete
== Description
-Use the FTP delete action to delete files on an FTP server.
+The FTP delete action deletes files on an FTP server.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpput.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpput.adoc
index 4a83eb8..9142e67 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpput.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ftpput.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Put A File With FTP action uploads a file to an FTP server.
= Put a file with FTP
== Description
-Use the Put a file with FTP action to upload a file to an FTP server.
+The Put A File With FTP action uploads a file to an FTP server.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/getpop.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/getpop.adoc
index 244a935..4088555 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/getpop.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/getpop.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Get Mail From POP action retrieves mails from a POP server
and stores them into one or more files.
= Get Mail from POP
== Description
-The Get Mail from POP action allows you to retrieve mails from a POP server
and store them into one or more files.
+The Get Mail From POP action retrieves mails from a POP server and stores them
into one or more files.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/http.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/http.adoc
index 3e9da7e..7758ec1 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/http.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/http.adoc
@@ -16,16 +16,22 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The HTTP Get action retrieves a file from a Web server using the
HTTP protocol.
= Http Get
== Description
-Use the HTTP action to retrieve a file from a Web server using the HTTP
protocol.
-This workflow action could be used to access data on partner Web sites.
+The HTTP Get action retrieves a file from a Web server using the HTTP protocol.
+
+This action could be used to access data on partner Web sites.
+
For example, the daily data export or daily list of customers is located at a
specified Web site.
+
Also, SaaS providers may give you a URL to locate a report.
+
You can call that URL to retrieve an Excel file or zip file that contains the
data.
+
Salesforce requires that you use SOAP APIs to retrieve data.
If HTTP traffic is too heavy in your corporate environment, you may choose to
use a proxy server with HTTP authentication.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mail.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mail.adoc
index 207241c..5289d22 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mail.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mail.adoc
@@ -16,21 +16,28 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Mail action sends a text or HTML email with optional file
attachments.
= Mail
== Description
-Use the Mail action to send a text or HTML email with optional file
attachments.
-This workflow action is used at the end of a workflow run in most instances.
+The Mail action sends a text or HTML email with optional file attachments.
+
+This action is used at the end of a workflow run in most instances.
+
It can be used to announce both a workflow failure or success.
+
For example, it is not uncommon at the end of a successful load, to send an
email to a distribution list announcing that the load was successful and
include a log file.
+
If there are errors, an email can be sent to alert individuals on a
distribution list.
The Mail action requires an SMTP server.
+
You can use authentication and security as part of the connection but you must
have the SMTP credentials.
You can attach files to your email messages such as error logs and regular
logs.
+
In addition, logs can be zipped into a single archive for convenience.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mailvalidator.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mailvalidator.adoc
index e0b6f56..148a774 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mailvalidator.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mailvalidator.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Mail Validator action checks if an email address is valid or
not.
= Mail Validator
== Description
The Mail Validator action checks if an email address is valid or not.
+
The checking process returns one result field (Boolean or String depending on
your settings) and one additionnal field (String) containing errors string when
email address is not valid.
This action must receive input stream and add result fields in this input
stream.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/movefiles.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/movefiles.adoc
index b8d75b2..6d83cad 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/movefiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/movefiles.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Move Files action moves a number of files and/or folders to
alternate locations on your file system.
= Move Files
== Description
-The Move Files action allows you to move a number of files and/or folders to
alternate locations on your file system.
+The Move Files action moves a number of files and/or folders to alternate
locations on your file system.
This works also on remote file systems (via VFS, e.g. with FTP.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/msgboxinfo.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/msgboxinfo.adoc
index 17c66f3..87ae6e5 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/msgboxinfo.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/msgboxinfo.adoc
@@ -16,14 +16,15 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Display Msgbox info action allow you to display a message
box in a workflow so you can easily see where you are in the process.
= Display Msgbox info
== Description
-The Display Msgbox info action allow you to display a message box in a
workflow.
-You can easily see where you are in the process.
-This workflow action is only available using the Graphical User Interface to
execute the workflow.
+The Display Msgbox info action allow you to display a message box in a
workflow so you can easily see where you are in the process.
+
+This action is only available using the Graphical User Interface to execute
the workflow.
The message box displays "OK" and "Cancel" buttons.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mssqlbulkload.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mssqlbulkload.adoc
index 35b8f4e..ce9e55d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mssqlbulkload.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mssqlbulkload.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The MS SQL Server Bulk Loader action bulk loads data from a file
into MSSQL.
= MS SQL Server Bulk Loader
== Description
-The MS SQL Server Bulk Loader action can bulk load data from a file into MSSQL.
+The MS SQL Server Bulk Loader action bulk loads data from a file into MSSQL.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkfile.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkfile.adoc
index 1f661d8..66f8ea8 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkfile.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkfile.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The MySQL Bulk File action bulk loads data from MySQL into a
file.
= MySQL Bulk File
== Description
-The MySQL Bulk File action can bulk load data from MySQL into a file.
+The MySQL Bulk File action bulk loads data from MySQL into a file.
== Options
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkload.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkload.adoc
index 50e8ac2..983f8a1 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkload.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mysqlbulkload.adoc
@@ -16,6 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The MySQL Bulk Loader action loads data from a text file into a
MySQL table.
= MySQL Bulk Loader
