You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ha...@apache.org on 2021/10/24 20:33:48 UTC
[incubator-hop] branch master updated: HOP-3267 action docs cleanup
and descriptions n-z
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 4250abd HOP-3267 action docs cleanup and descriptions n-z
new 312ad30 Merge pull request #1170 from bamaer/HOP-3267
4250abd is described below
commit 4250abd0d726be3016a239b76154a33f0aa4a0c8
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Sat Oct 23 07:19:53 2021 +0200
HOP-3267 action docs cleanup and descriptions n-z
---
docs/hop-user-manual/modules/ROOT/nav.adoc | 1 -
.../ROOT/pages/pipeline/transforms/writetolog.adoc | 2 ++
.../workflow/actions/neo4j-checkconnections.adoc | 4 +++-
.../pages/workflow/actions/neo4j-constraint.adoc | 3 ++-
.../pages/workflow/actions/neo4j-cypherscript.adoc | 7 +++++--
.../ROOT/pages/workflow/actions/neo4j-index.adoc | 3 ++-
.../ROOT/pages/workflow/actions/pgpdecryptfiles.adoc | 3 ++-
.../ROOT/pages/workflow/actions/pgpencryptfiles.adoc | 3 ++-
.../ROOT/pages/workflow/actions/pgpfiles.adoc | 20 --------------------
.../ROOT/pages/workflow/actions/pgpverify.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/ping.adoc | 2 ++
.../ROOT/pages/workflow/actions/pipeline.adoc | 5 ++++-
.../ROOT/pages/workflow/actions/repeat-end.adoc | 9 +++++----
.../modules/ROOT/pages/workflow/actions/repeat.adoc | 4 +++-
.../pages/workflow/actions/runpipelinetests.adoc | 5 ++++-
.../workflow/actions/sendnagiospassivecheck.adoc | 5 ++++-
.../ROOT/pages/workflow/actions/setvariables.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/sftp.adoc | 5 ++++-
.../modules/ROOT/pages/workflow/actions/sftpput.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/shell.adoc | 10 +++++++++-
.../ROOT/pages/workflow/actions/simpleeval.adoc | 7 +++++--
.../ROOT/pages/workflow/actions/snmptrap.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/sql.adoc | 6 +++++-
.../modules/ROOT/pages/workflow/actions/start.adoc | 5 +++--
.../modules/ROOT/pages/workflow/actions/success.adoc | 5 +++--
.../ROOT/pages/workflow/actions/tableexists.adoc | 9 +++++++--
.../modules/ROOT/pages/workflow/actions/telnet.adoc | 3 ++-
.../ROOT/pages/workflow/actions/truncatetables.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/unzip.adoc | 3 ++-
.../ROOT/pages/workflow/actions/waitforfile.adoc | 7 +++++--
.../ROOT/pages/workflow/actions/waitforsql.adoc | 3 ++-
.../pages/workflow/actions/webserviceavailable.adoc | 5 ++++-
.../ROOT/pages/workflow/actions/workflow.adoc | 7 ++++++-
.../ROOT/pages/workflow/actions/writetofile.adoc | 5 +++--
.../ROOT/pages/workflow/actions/writetolog.adoc | 9 ++++++++-
.../ROOT/pages/workflow/actions/xmlwellformed.adoc | 5 +++--
.../ROOT/pages/workflow/actions/xsdvalidator.adoc | 2 ++
.../modules/ROOT/pages/workflow/actions/xslt.adoc | 3 ++-
.../modules/ROOT/pages/workflow/actions/zipfile.adoc | 1 +
39 files changed, 126 insertions(+), 65 deletions(-)
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc b/docs/hop-user-manual/modules/ROOT/nav.adoc
index 2a27870..0e5608f 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -294,7 +294,6 @@ under the License.
*** xref:workflow/actions/neo4j-constraint.adoc[Neo4j Constraint]
*** xref:workflow/actions/neo4j-cypherscript.adoc[Neo4j Cypher Script]
*** xref:workflow/actions/neo4j-index.adoc[Neo4j Index]
-*** xref:workflow/actions/pgpfiles.adoc[PGP Files]
*** xref:workflow/actions/ping.adoc[Ping]
*** xref:workflow/actions/pipeline.adoc[Pipeline]
*** xref:workflow/actions/ftpput.adoc[Put a file with FTP]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/writetolog.adoc b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/writetolog.adoc
index f0f1421..cda6218 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/writetolog.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/writetolog.adoc
@@ -26,6 +26,8 @@ The Write To Log transform writes information to the Hop logging system.
Typical use cases are logging specific values or custom logging messages to the Hop logs.
+TIP: be careful when writing variables or fields for (unencrypted) passwords or other sensitive information to the Hop logging system!
+
== Options
[width="90%",options="header"]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-checkconnections.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-checkconnections.adoc
index ab5ae66..016a87a 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-checkconnections.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-checkconnections.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Check Neo4j Connections action lines up a list of Neo4j connections that you want to check for availability.
= Check Neo4j Connections
== Description
-This action allows you to line up a list of Neo4j connections that you want to check for availability.
+The Check Neo4j Connections action lines up a list of Neo4j connections that you want to check for availability.
+
A small static value will be retrieved from the server to see if it's properly up-and-running.
== Configuration
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-constraint.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-constraint.adoc
index a565936..ba59557 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-constraint.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-constraint.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Neo4j Constraint action can be used to create or drop constraints on node or relationship properties in a Neo4j Graph
= Neo4j Constraint
== Description
-This action can be used to create or drop constraints on node or relationship properties in a Neo4j Graph
+The Neo4j Constraint action can be used to create or drop constraints on node or relationship properties in a Neo4j Graph
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-cypherscript.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-cypherscript.adoc
index d613792..cc4932d 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-cypherscript.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-cypherscript.adoc
@@ -16,15 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Neo4j Cypher Script action executes Cypher statements in a workflow.
:openvar: ${
:closevar: }
+
= Neo4j Cypher Script
== Description
-With this action you can execute Cypher statements in a workflow.
-The goal is not to retrieve data but to execute various statements like creating or dropping indexes, calling APOC procedures, add or delete some static data and so on.
+The Neo4j Cypher Script action executes Cypher statements in a workflow.
+
+As with all actions, the goal is not to retrieve data but to execute various statements like creating or dropping indexes, calling APOC procedures, add or delete some static data and so on.
== Important
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-index.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-index.adoc
index 24655d8..18360c3 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/neo4j-index.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Neo4j Index action can be used to create or drop indexes on node or relationship properties in a Neo4j Graph
= Neo4j Index
== Description
-This action can be used to create or drop indexes on node or relationship properties in a Neo4j Graph
+The Neo4j Index action can be used to create or drop indexes on node or relationship properties in a Neo4j Graph
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpdecryptfiles.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpdecryptfiles.adoc
index 6160616..2ba1ce4 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpdecryptfiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpdecryptfiles.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Decrypt Files With PGP action can be used to decrypt files.
= Decrypt files with PGP
== Description
-This workflow action can be used to decrypt files.
+The Decrypt Files With PGP action can be used to decrypt files.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
index 27e099a..d055c2c 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Encrypt Files With PGP action can be used to encrypt and sign files.
= Encrypt files with PGP
== Description
-This workflow action can be used to encrypt and sign files.
+The Encrypt Files With PGP action can be used to encrypt and sign files.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpfiles.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpfiles.adoc
deleted file mode 100644
index d58758f..0000000
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpfiles.adoc
+++ /dev/null
@@ -1,20 +0,0 @@
-////
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
-////
-:documentationPath: /workflow/actions/
-:language: en_US
-
-= PGP Files
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpverify.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpverify.adoc
index 5db9b2d..82dd6cd 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpverify.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpverify.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Verify File Signature With PGP action can be used to verify a file signature to ensure its authenticity.
= Verify file signature with PGP
== Description
-This workflow action can be used to verify a file link:https://www.gnupg.org/gph/en/manual/x135.html[signature to ensure its authenticity].
+The Verify File Signature With PGP action can be used to verify a file link:https://www.gnupg.org/gph/en/manual/x135.html[signature to ensure its authenticity].
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ping.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ping.adoc
index 55bfba7..48b5ebf 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ping.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/ping.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Ping action can be used to ping a host using the ICMP protocol.
= Ping
== Description
The Ping action can be used to ping a host using the ICMP protocol.
+
The result it true when the host is reachable, otherwise false.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
index acc9e57..fd6466d 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
@@ -16,15 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description:
:openvar: ${
:closevar: }
+
= Pipeline
== Description
The Pipeline action runs a previously-defined pipeline within a workflow.
-This action is the access point from your workflow to your ETL activity (pipeline).
+
+This action is the access point from your workflow to your actual data processing activity (pipeline).
An example of a common workflow includes getting FTP files, checking existence of a necessary target database table, running a pipeline that populates that table, and e-mailing an error log if a pipeline fails.
For this example, the Pipeline action defines which pipeline to run to populate the table.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
index f41a5f6..574c8ee 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
@@ -16,15 +16,16 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description:
= End Repeat
== Description
-This action allows you to a end repeating workflow which is executed by the Repeat action.
+The End Repeat action ends a repeating workflow which is executed by the xref:workflow/actions/repeat.adoc[Repeat] action.
+
It leaves a flag in the parent workflow to signal it can stop repeating at the next opportunity.
-*NOTE* The End Repeat action only works against its parent workflow when it's being executed by the Repeat action.
+TIP: The End Repeat action only works against its parent workflow when it's being executed by the Repeat action.
-This action has no options.
-It works as a "Success" action and clears possible previous errors.
+This action has no options. It works as a "Success" action and clears possible previous errors.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
index 2db8b3b..ddeb9a6 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Repeat action repeats the pipeline or workflow of your choice until a certain condition is met.
= Repeat
== Description
-This action allows you to repeat the pipeline or workflow of your choice until a certain condition.
+The Repeat action repeats the pipeline or workflow of your choice until a certain condition is met.
+
The condition is either:
* A variable in the workflow is set or set to a certain value
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
index 2fd71d1..aaefba0 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
@@ -16,13 +16,16 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Run Pipeline Tests action runs a series of pipeline unit tests.
= Run Pipeline Tests
== Description
-This action runs a series of pipeline unit tests.
+The Run Pipeline Tests action runs a series of pipeline unit tests.
+
The action is successful if all tests run without error.
+
Errors are logged.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
index 8fb17ef..0862fc6 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
@@ -16,15 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Send Nagios check action sends passive checks to Nagios.
= Send Nagios check
== Description
-The Send Nagios check action allows you to send passive checks to Nagios.
+The Send Nagios check action sends passive checks to Nagios.
+
You can send monitoring information e.g. about start and end processes within your workflow.
It needs the NCSA addon installed on the Nagios server (NSCA is a Linux/Unix daemon allows you to integrate passive alerts and checks from remote machines and applications with Nagios.
+
Useful for processing security alerts, as well as redundant and distributed Nagios setups.)
More details and setup instructions for the Nagios NSCA addon can be found at the Nagios link:http://nagios.sourceforge.net/docs/3_0/passivechecks.html[Passive Checks documentation.]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setvariables.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setvariables.adoc
index 23647b7..4063874 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setvariables.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setvariables.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Set Variables action sets variables at various scopes.
= Set Variables
== Description
-The Set Variables action can be used to set variables at various scopes.
+The Set Variables action sets variables at various scopes.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftp.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftp.adoc
index 4241743..cb4763f 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftp.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftp.adoc
@@ -16,12 +16,15 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Get A File With SFTP action retrieves one or more files from an FTP server using the Secure FTP protocol.
= Get a file with SFTP
== Description
-The Get a file with SFTP action can be used to retrieve one or more files from an FTP server using the Secure FTP protocol.
+The Get A File With SFTP action retrieves one or more files from an FTP server using the Secure FTP protocol.
+
+The action returns true if the specified file(s) or pattern were retrieved successfully, false it there were problems retrieving the file(s).
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftpput.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftpput.adoc
index 34d1ee4..19e41ef 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftpput.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sftpput.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Put files with SFTP action pushes one or more files to an FTP server using the Secure FTP protocol.
= Put a file with SFTP
== Description
-You can use the Put files with SFTP action to put one or more files from an FTP server using the Secure FTP protocol.
+The Put files with SFTP action pushes one or more files to an FTP server using the Secure FTP protocol.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/shell.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/shell.adoc
index a9da392..6b879a8 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/shell.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/shell.adoc
@@ -16,20 +16,28 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description:
= Shell Action
== Description
-The Shell action can be used to execute a shell script on the host where the workflow is running.
+The Shell action executes a shell script on the host where the workflow is running.
+
For example, suppose you have a program that reads five data tables and creates a file in a specified format.
+
You know the program works.
+
Shell allows you to do portions of your work in Hop but reuse the program that reads the data tables as needed.
The Shell workflow action is platform agnostic; you can use a batch file, UNIX, and so on.
+
When you use a Shell workflow action, Hop makes a Java call to execute a program in a specified location.
+
The return status is provided by the operating system call.
+
For example, in batch scripting a return value of 1 indicates that the script was successful; a return value of 0 (zero) indicates that it was unsuccessful.
+
You can pass command line arguments and set up logging for the Shell workflow action.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/simpleeval.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/simpleeval.adoc
index 84ba40b..171bd49 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/simpleeval.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/simpleeval.adoc
@@ -16,17 +16,20 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Simple Evaluation action evaluates contents of a variable or a field in the result stream.
:openvar: ${
:closevar: }
+
= Simple Evaluation
== Description
-The Simple Evaluation action can be used to evaluate contents of a variable or a field in the result stream.
+The Simple Evaluation action evaluates contents or value of a variable or a field in the result stream.
Connect two actions with the output of the Simple Evaluation.
-The green connection will be called on success, the red one on failure.
+
+The green (success) hop will be called if the condition was evaluated successfully, the red (failure) one will be called if the condition wasn't evaluated successfully.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
index 2a13a3a..bdca934 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The SNMP Trap action sends alert messages to a remote SNMP-enabled device.
= Snmp Trap
== Description
-The Snmp Trap action can be used to send alert messages to a remote SNMP-enabled device.
+The SNMP Trap action sends alert messages to a remote SNMP-enabled device.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sql.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sql.adoc
index 093e11d..c1c58ab 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sql.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sql.adoc
@@ -16,14 +16,18 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The SQL Script Executor action executes one or more SQL scripts from this action's configuration or from a file.
= SQL Script Executor
== Description
-The SQL Script Executor action can be used to execute an SQL script.
+The SQL Script Executor action executes one or more SQL scripts from this action's configuration or from a file.
+
You can execute more than one SQL statement, as long as they are separated by semi-colons.
+
The SQL workflow action is flexible; you can perform procedure calls, create and analyze tables, and more.
+
Common uses associated with the SQL workflow action include truncating tables, drop index, partition loading, refreshing materialized views, disabling constraints, disabling statistics, and so on..
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/start.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/start.adoc
index 2f2d711..13a24e3 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/start.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/start.adoc
@@ -16,11 +16,12 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description:
= Start
== Description
-The start action is starting point for workflow execution.
+The Start action is the starting point for workflow execution.
-NOTE: You can have only one start action in a workflow.
+NOTE: Every workflow needs to have one and only one start action.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/success.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/success.adoc
index 69c61f0..8704e4e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/success.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/success.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Success action clears any error state encountered in a workflow and forces it to a success state.
-= Success Action
+= Success
== Description
-The Success Action action clears any error state encountered in a workflow and forces it to a success state.
+The Success action clears any error state encountered in a workflow and forces it to a success state.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/tableexists.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/tableexists.adoc
index 7468304..d4a5a22 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/tableexists.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/tableexists.adoc
@@ -16,17 +16,22 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Table Exists action verifies that a specified table exists on a database.
= Table Exists
== Description
-The Table Exists action can be used to verify that a specified table exists on a database.
+The Table Exists action verifies that a specified table exists on a database.
+
You must provide a connection and the table name.
-Hop returns a True or False value depending on whether or not the table exists.
+
+Hop returns a True or False value depending on whether the table exists.
Suppose you have an external system that creates a summary table or yesterday's data extract.
+
The external system may not have performed the action yet, so you set up a polling piece that waits for the staged data to arrive in the database.
+
There is no point in processing the workflow until the data is available, so you can use this workflow action as a semaphore that polls the database to determine whether or not the table exists.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/telnet.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/telnet.adoc
index cbab583..6d74b43 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/telnet.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/telnet.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Telnet action tests a connection on a certain port over the Telnet protocol.
= Telnet a host
== Description
-The Telnet action can be used to test a connection over a certain port.
+The Telnet action tests a connection on a certain port over the https://en.wikipedia.org/wiki/Telnet[Telnet^] protocol.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/truncatetables.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/truncatetables.adoc
index d3f7067..0bf3daa 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/truncatetables.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/truncatetables.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Truncate Tables action truncates one or several tables at once without writing 0 SQL command.
= Truncate Tables
== Description
-The Truncate Tables action allows you to truncate one or several tables at once without writing 0 SQL command.
+The Truncate Tables action truncates one or several tables at once without writing 0 SQL command.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/unzip.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/unzip.adoc
index bda672f..46b416f 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/unzip.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/unzip.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Unzip action unzips one or more files to a specified target location.
= Unzip
== Description
-The Unzip action can be used to unzip one or more files with this workflow action.
+The Unzip action unzips one or more files to a specified target location.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforfile.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforfile.adoc
index 891a6c2..930f7ff 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforfile.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforfile.adoc
@@ -16,14 +16,17 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Wait For File action waits and periodically checks for a file.
= Wait for file
== Description
-The Wait for file action can be used to wait for a file.
+The Wait For File action waits and periodically checks for a file.
+
This workflow action will sleep and periodically check whether the specified file exists after which the flow will continue.
-The action can either wait indefinitely for the file or it can timeout after a certain time.
+
+The action can either wait indefinitely for the file or it can time out after a certain time.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforsql.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforsql.adoc
index c50e902..15e141a 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforsql.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/waitforsql.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Wait For SQL action scans a database and checks if the database meets user-defined conditions.
= Wait for SQL
== Description
-The Wait for SQL action scans a database and checks if the database meets user-defined conditions.
+The Wait For SQL action scans a database and checks if the database meets user-defined conditions.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/webserviceavailable.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/webserviceavailable.adoc
index 658cd5b..8096212 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/webserviceavailable.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/webserviceavailable.adoc
@@ -16,13 +16,16 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Check If Webservice is available action checks if a given URL (e.g. a Webservice URL) is valid, can be connected and data can be read from.
= Check if Webservice is available
== Description
-The Check if Webservice is available action checks if a given URL (e.g. a Webservice URL) is valid, can be connected and data can be read from.
+The Check If Webservice is available action checks if a given URL (e.g. a Webservice URL) is valid, can be connected and data can be read from.
+
If it connects within the given timeout and data can be read, it returns 'true', otherwise 'false'.
+
Further information of the failing reason can be found in the log as an error log action.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
index f57dc51..576257b 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
@@ -16,20 +16,25 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Workflow action executes a previously defined workflow from the current workflow.
:openvar: ${
:closevar: }
+
= Workflow
== Description
-You can use the Workflow action to execute a previously defined workflow.
+The Workflow action executes a previously defined workflow from the current workflow.
For ease of use, it is also possible to create a new workflow within the dialog, pressing the New Workflow button.
Use the Workflow action to execute a previously defined workflow.
+
This allows you to perform "functional decomposition." That is, you use them to break out workflows into more manageable units.
+
For example, you would not write a data warehouse load using one workflow that contains 500 actions.
+
It is better to create smaller workflows and aggregate them.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetofile.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetofile.adoc
index 247dd8a..efb3a1b 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetofile.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetofile.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description:
= Write to File
== Description
-The Write to File action can be used to write text to a file.
+The Write To File action writes text to a file.
== Options
@@ -31,7 +32,7 @@ The Write to File action can be used to write text to a file.
|Workflow action name|The name of the workflow action.
|File name|The file directory and name.
|Browse...|Browse the filesystem for a file location.
-|Create prarent folder|Whether or not to create the parent folder.
+|Create parent folder|Whether to create the parent folder.
|Append file|Will overwrite the previous file if unchecked, if checked it will append new text to the previous file.
|Encoding|The encoding to use while writing the file.
|Text|The text to write to the file.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetolog.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetolog.adoc
index 0bad464..1fd4579 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetolog.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/writetolog.adoc
@@ -16,12 +16,19 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Write To Log action writes a specific string to the Hop logging system.
= Write to Log
== Description
-The Write to log acction writes a specific string to the Hop logging system.
+The Write To Log action writes a specific string to the Hop logging system.
+
+This action is similar to the xref:pipeline/transforms/writetolog.adoc[Write To Log] transform.
+
+Typical use cases are logging variable values and additional, custom logging information to the Hop logging system.
+
+TIP: be careful when writing variables for (unencrypted) passwords or other sensitive information to the Hop logging system!
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xmlwellformed.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xmlwellformed.adoc
index 68cf96a..351b197 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xmlwellformed.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xmlwellformed.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Check If XML File Is Well-Formed action verifies if one or more files contain well-formed (allowed) XML content.
-= Check if XML file is well formed
+= Check if XML file is well-formed
== Description
-The Check if XML file is well formed action verifies if one or more files contain well formed (allowed) XML content.
+The Check If XML File Is Well-Formed action verifies if one or more files contain well-formed (allowed) XML content.
== Options
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xsdvalidator.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xsdvalidator.adoc
index 54e6396..045a4f0 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xsdvalidator.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xsdvalidator.adoc
@@ -16,12 +16,14 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The XSD Validator action performs an XSD validation against data in a file or in an input field.
= XSD Validator
== Description
The XSD Validator action performs an XSD validation against data in a file or in an input field.
+
XSD is short for link:http://en.wikipedia.org/wiki/XML_Schema_(W3C)[XML Schema] Definition.
As such, there are 2 entities at work here:
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xslt.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xslt.adoc
index 5073b17..018c82b 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xslt.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/xslt.adoc
@@ -16,12 +16,13 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The XSL Transformation action transforms XML documents into other documents (XML or other format, such as HTML or plain text) using Extensible Stylesheet Language Transformations or XSLT.
= XSL Transformation
== Description
-The XSL Transformation action is designed to transform XML documents into other documents (XML or other format, such as HTML or plain text) using Extensible Stylesheet Language Transformations or link:http://en.wikipedia.org/wiki/XSLT[XSLT].
+The XSL Transformation action transforms XML documents into other documents (XML or other format, such as HTML or plain text) using Extensible Stylesheet Language Transformations or link:http://en.wikipedia.org/wiki/XSLT[XSLT].
The original document is not changed; rather, a new document is created based on the content of the XML file.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/zipfile.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/zipfile.adoc
index 3bccf6a..ed7fbfb 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/zipfile.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/zipfile.adoc
@@ -16,6 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
+:description: The Zip File action creates a standard ZIP archive using the options you specify in the dialog.
= Zip File