This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hop-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 8fb08e7beb Website updated to 481ea60
8fb08e7beb is described below
commit 8fb08e7bebe7fce9439ad16b7d30f06d28b9a79c
Author: jenkins <[email protected]>
AuthorDate: Sun Oct 18 09:49:09 2026 +0000
Website updated to 481ea60
---
manual/next/workflow/actions/copyfiles.html | 38 +++++++++++++++++++
manual/next/workflow/actions/mail.html | 52 ++++++++++++++++++++++++-
manual/next/workflow/actions/pipeline.html | 57 ++++++++++++++++++++++++----
manual/next/workflow/actions/sftp.html | 42 ++++++++++++++++++++
manual/next/workflow/actions/simpleeval.html | 50 ++++++++++++++++++++++++
manual/next/workflow/actions/workflow.html | 51 +++++++++++++++++++++++--
6 files changed, 278 insertions(+), 12 deletions(-)
diff --git a/manual/next/workflow/actions/copyfiles.html
b/manual/next/workflow/actions/copyfiles.html
index 99da2043b2..c5d8e9b81c 100644
--- a/manual/next/workflow/actions/copyfiles.html
+++ b/manual/next/workflow/actions/copyfiles.html
@@ -3079,6 +3079,44 @@ If you choose an option other than <Static> in the
Destination Environment
</tbody>
</table>
</div>
+</div>
+<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Every
source and destination pair was processed. A file that can’t be copied
inside a folder is only logged: the action is still true, with 0
errors.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">At least
one pair failed, for example because the source doesn’t exist or the
destination folder can’t be found. The number of errors is the number of
pairs that failed.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add files to result files name</strong>, the files copied to a file
(<strong>Destination is a file</strong>) and the files copied from a folder are
added. A single file copied into a folder is not added, and neither are
folders. The files the action received are passed on.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged. With <strong>Copy previous results to arguments</strong>, the action
takes its pairs from the result rows instead of the Files tab: the source in
the first field, the destination in the second and the wildcard in the
third.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/mail.html
b/manual/next/workflow/actions/mail.html
index 243ab7a300..0f23b1597a 100644
--- a/manual/next/workflow/actions/mail.html
+++ b/manual/next/workflow/actions/mail.html
@@ -3178,7 +3178,7 @@ Note: The support of this flag is depending on the mail
server.</p>
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Attach
files to message?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Attach
file(s) to message</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable to
attach a file to your email message</p></td>
</tr>
<tr>
@@ -3238,6 +3238,56 @@ Note: This works only when Use HTML format is defined in
the EMail Message tab.<
</div>
</div>
<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
message was sent and no error was counted.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
message could not be sent, for example because no server is set, the connection
or the login failed, or an address is invalid. It is also false when an error
was counted while preparing the attachments, even though the message is sent:
with <strong>Zip files to single archive</strong>, a zip that can’t be
created is left out and the message goes out without it. The number of errors
is 1.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged. With <strong>Attach file(s) to message</strong>, the result files of
the selected types are attached to the message. A result file that no longer
exists is skipped without an error, unless <strong>Zip files to single
archive</strong> is enabled.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+When the selected <a href="../../metadata-types/mail-server-connection.html"
class="xref page">Mail server connection</a> doesn’t exist, the action
doesn’t return false: the workflow stops with an error, and no hop is
followed.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_tips"><a class="link" href="#_tips">Tips</a></h2>
<div class="sectionbody">
<div class="paragraph">
diff --git a/manual/next/workflow/actions/pipeline.html
b/manual/next/workflow/actions/pipeline.html
index dbefc1b19c..23f8df324f 100644
--- a/manual/next/workflow/actions/pipeline.html
+++ b/manual/next/workflow/actions/pipeline.html
@@ -3035,17 +3035,13 @@ Select the desired run configuration to control where
and how the pipeline is ex
<td class="tableblock halign-left valign-top"><p class="tableblock">Makes sure
the results files are cleared before the pipeline starts.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Wait for
remote pipeline to finish</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">If you
selected Server as your environment type, choose this option to block the
workflow until the pipeline runs on the server.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Wait for
the pipeline to complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Blocks the
workflow until the pipeline has finished, so this action returns the result of
the pipeline. Enabled by default.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Stop after
(milliseconds)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum
time to wait for the pipeline to complete. Empty or 0 means wait indefinitely.
When the time is reached the pipeline is stopped and this action fails. Only
used when wait-to-finish is enabled. The value may contain a variable.</p></td>
</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Follow
local abort to remote pipeline</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">If you
selected Server as your environment type, choose this option to send the local
abort signal remotely.</p></td>
-</tr>
</tbody>
</table>
</div>
@@ -3128,8 +3124,8 @@ A value you fill in here overrides the
sub-pipeline’s own default for this
</div>
<table class="tableblock frame-all grid-all" style="width: 90%;">
<colgroup>
-<col style="width: 50%;">
-<col style="width: 50%;">
+<col style="width: 25%;">
+<col style="width: 75%;">
</colgroup>
<thead>
<tr>
@@ -3169,6 +3165,51 @@ A value you fill in here overrides the
sub-pipeline’s own default for this
</table>
</div>
</div>
+</div>
+<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
pipeline ran without errors. With <strong>Execute for every result
row</strong>, every run did.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
pipeline could not be loaded or started, the log file of <strong>Specify
logfile</strong> could not be created, one of its transforms had an error, or
<strong>Stop after (milliseconds)</strong> was reached. The number of errors
comes from the pipeline. With <strong>Execute for every result row</strong>,
the first run that fails ends the loop: the remaining rows are not
processed.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The files
the pipeline added to the result are added to the files the action received,
plus the log file with <strong>Specify logfile</strong>. <strong>Clear results
files before execution</strong> empties the list before every run, so with
<strong>Execute for every result row</strong> only the files of the last run
are kept.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">When the
pipeline contains a <a href="../../pipeline/transforms/copyrowstoresult.html"
class="xref page">Copy rows to result</a> transform, its rows replace the rows
the action received, even when it copies none. Otherwise the rows are passed on
unchanged. <strong>Clear results rows before execution</strong> empties the
list first. With <strong>Execute for every result row</strong>, every run
receives only its own row, a [...]
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Metrics</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The line
counts and the number of errors of the pipeline. With <strong>Execute for every
result row</strong>, those of the last run.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>Without <strong>Wait for the pipeline to complete</strong>, the result is
true as soon as the pipeline starts, and the files, rows and metrics of the
pipeline are not passed on.</p>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/sftp.html
b/manual/next/workflow/actions/sftp.html
index 6486e57bd0..e512c9d53f 100644
--- a/manual/next/workflow/actions/sftp.html
+++ b/manual/next/workflow/actions/sftp.html
@@ -3142,6 +3142,48 @@ A.*[ENG:0-9].txt : files tarting with A, ending with a
number and .txt</code></
</div>
</div>
<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The files
were retrieved without errors. This includes when no file matched, and when
<strong>Copy previous results to args</strong> is enabled and there are no
result rows.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
connection, the login or the change of remote directory failed, the target
directory doesn’t exist and <strong>Create target folder</strong> is not
enabled, a file could not be retrieved, or <strong>Remove files after
retrieval</strong> failed. In that last case the file was already downloaded
and added to the result files. The number of errors is 1.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add filenames to result</strong>, every file the action downloaded is
added, in the target directory, also when the action fails afterwards.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged. With <strong>Copy previous results to args</strong>, the action
retrieves the files whose name is exactly the first field of a result row, and
the wildcard is not used.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Metrics</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Files
retrieved: the number of files the action downloaded. It is only set when the
action succeeds: files downloaded before a failure are not counted.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="sect1">
<h2 id="negotiation_error"><a class="link" href="#negotiation_error">Algorithm
Negotiation Fail Error</a></h2>
<div class="sectionbody">
<div class="paragraph">
diff --git a/manual/next/workflow/actions/simpleeval.html
b/manual/next/workflow/actions/simpleeval.html
index 106c8302f4..66046e4adf 100644
--- a/manual/next/workflow/actions/simpleeval.html
+++ b/manual/next/workflow/actions/simpleeval.html
@@ -3074,6 +3074,56 @@
</div>
</div>
<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
condition under <strong>Success On</strong> is met. With <strong>Success when
source variable set</strong>, the variable is set.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
condition is not met, and the number of errors is 0. When the value can’t
be evaluated, the number of errors is 1: there are no result rows, the field
doesn’t exist, the <strong>Variable name</strong> field is empty, or the
value or the value to compare is not a valid number or date.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged. With <strong>Number of result files</strong>, the action evaluates
how many files it received.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on
unchanged. With <strong>Field from previous result</strong>, the action
evaluates the field in the first result row.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+An invalid regular expression with <strong>If value valid regex</strong>
doesn’t return false: the workflow stops with an error, and no hop is
followed.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_tips"><a class="link" href="#_tips">Tips</a></h2>
<div class="sectionbody">
<div class="paragraph">
diff --git a/manual/next/workflow/actions/workflow.html
b/manual/next/workflow/actions/workflow.html
index 8a65045b94..c7dbd81de8 100644
--- a/manual/next/workflow/actions/workflow.html
+++ b/manual/next/workflow/actions/workflow.html
@@ -3042,8 +3042,8 @@ For example, you can execute a workflow for each file
found in a directory.</p><
<td class="tableblock halign-left valign-top"><p
class="tableblock">false</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Wait for
the remote workflow to finish?</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Enable to
block until the workflow on the Hop Server has finished</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Wait for
remote workflow to complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Blocks the
workflow until the child workflow has finished, so this action returns the
result of the child workflow.</p></td>
<td class="tableblock halign-left valign-top"><p
class="tableblock">true</p></td>
</tr>
<tr>
@@ -3085,7 +3085,7 @@ If, however, you want all your log information kept in
one place, you must set u
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Specify
logfile?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Specify
logfile</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable to
specify a separate logging file for the execution of this workflow</p></td>
</tr>
<tr>
@@ -3181,6 +3181,51 @@ You can do this by:</p>
</table>
</div>
</div>
+</div>
+<div class="sect1">
+<h2 id="_result"><a class="link" href="#_result">Result</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>What this action passes on to the next action. See <a
href="../action-results.html" class="xref page">Action results</a> for how
results travel through a workflow.</p>
+</div>
+<table class="tableblock frame-all grid-all" style="width: 90%;">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 75%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Result</th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">True</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The child
workflow ended with a true result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
workflow could not be loaded or started, the log file of <strong>Specify
logfile</strong> could not be created, the child workflow ended with a false
result, or <strong>Stop after (milliseconds)</strong> was reached. With
<strong>Execute for every result row</strong>, the first run that fails ends
the loop: the remaining rows are not processed.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The result
files of the child workflow are added to the files the action received, plus
the log file with <strong>Specify logfile</strong>.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The child
workflow starts with the rows the action received. When it returns at least one
row, those rows replace the rows the action received; when it returns none, the
received rows are passed on. A child that doesn’t change the rows returns
them as it received them. With <strong>Execute for every result row</strong>,
every run receives only its own row, and the action passes on what the last run
left: the rows t [...]
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Metrics</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The line
counts and the number of errors of the child workflow. With <strong>Execute for
every result row</strong>, those of the last run.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>Without <strong>Wait for remote workflow to complete</strong>, the result
is true as soon as the child workflow starts, and its files, rows and metrics
are not passed on.</p>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
