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 9d3c327034 Website updated to 674c410
9d3c327034 is described below
commit 9d3c3270347652c37a7d30c712481158f770869e
Author: jenkins <[email protected]>
AuthorDate: Tue Oct 20 11:55:13 2026 +0000
Website updated to 674c410
---
manual/next/workflow/actions/createfile.html | 38 ++++++++++++++++++
manual/next/workflow/actions/deletefiles.html | 56 +++++++++++++++++++++++++--
manual/next/workflow/actions/fileexists.html | 40 ++++++++++++++++++-
manual/next/workflow/actions/movefiles.html | 54 +++++++++++++++++++++++++-
manual/next/workflow/actions/shell.html | 56 ++++++++++++++++++++++++---
manual/next/workflow/actions/zipfile.html | 50 ++++++++++++++++++++++++
6 files changed, 282 insertions(+), 12 deletions(-)
diff --git a/manual/next/workflow/actions/createfile.html
b/manual/next/workflow/actions/createfile.html
index db74639a9d..126809660e 100644
--- a/manual/next/workflow/actions/createfile.html
+++ b/manual/next/workflow/actions/createfile.html
@@ -2988,6 +2988,44 @@ The default is on.</p></td>
</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">The file
was created, with any missing parent folders, or it already existed and
<strong>Fail if file exists</strong> is off.</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 file
already exists and <strong>Fail if file exists</strong> is on, with 0 errors,
or no <strong>File name</strong> is set, also with 0 errors. When the file
can’t be created, for example in a folder that can’t be written,
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 filename to result</strong>, the file is added, also when it
already existed, even when the action is false because of <strong>Fail if file
exists</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">Passed on
unchanged.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/deletefiles.html
b/manual/next/workflow/actions/deletefiles.html
index 28d63a7f02..dc57c4b353 100644
--- a/manual/next/workflow/actions/deletefiles.html
+++ b/manual/next/workflow/actions/deletefiles.html
@@ -2974,11 +2974,11 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Include
Subfolders</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Also
delete the subfolders in the folder selection</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Also
delete the matching files in the subfolders of a folder. Folders are never
deleted.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to args?</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Enable
this if the set of files comes from a previous workflow action (as part of the
result files)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to args</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Take the
files and folders to delete from the result rows of a previous action: the path
in the first field and the wildcard in the second. See <a
href="#_result">Result</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">File/Folder</p></td>
@@ -2996,6 +2996,56 @@ For example to delete all files ending in .dat, the
regular expression would be
</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 file
and folder in the list was processed. A path that doesn’t exist counts as
already deleted. For a single file the wildcard is not used.</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">A file
could not be deleted. The number of errors is the number of entries in the list
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">Passed on
unchanged. The deleted files are not added.</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
takes the path from the first field and the wildcard from the second field of
each result row, and ignores the list in the dialog, also when there are no
result rows. A row with fewer than two fields stops the action: the remaining
rows are not processed, and the action is still true.</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 in <strong>Wildcard</strong> deletes nothing,
and the action is still true.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/fileexists.html
b/manual/next/workflow/actions/fileexists.html
index d1c495ba21..ffdc6fc0a5 100644
--- a/manual/next/workflow/actions/fileexists.html
+++ b/manual/next/workflow/actions/fileexists.html
@@ -2997,13 +2997,51 @@
<td class="tableblock halign-left valign-top"><p class="tableblock">The name
of the workflow action.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Filename
field</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">File
name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Specify
the filename and path of the file to verify.
Click Browse to navigate to the source file or folder through the VFS
browser.</p></td>
</tr>
</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">The file
or folder exists and can be read.</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 file
doesn’t exist or can’t be read, and the number of errors is 0. The
number of errors is 1 when <strong>File name</strong> is not set or the file
can’t be checked.</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. The file is not added.</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>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/movefiles.html
b/manual/next/workflow/actions/movefiles.html
index 9bbfb04528..eaf7d55437 100644
--- a/manual/next/workflow/actions/movefiles.html
+++ b/manual/next/workflow/actions/movefiles.html
@@ -3013,7 +3013,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to args</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Use the
result files from the previous workflow action (actions) as files and/or
folders to move.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Take the
files and folders to move from the result rows of a previous action: the source
in the first field, the destination in the second and the wildcard in the
third. See <a href="#_result">Result</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Files /
Folders</p></td>
@@ -3193,13 +3193,63 @@ The default is yyyyMMdd'_'HHmmss</p>
<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files moved or the number of errors, depending on the success option
above</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Add files
to result files name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add the
target file names to the list of result files of this workflow action for use
in the next workflow actions.</p></td>
</tr>
</tbody>
</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
<strong>Success condition</strong> is met: no errors with <strong>Success when
all works fine</strong>, at least <strong>Nr errors lesser than</strong> files
moved with <strong>Success when at least x files moved</strong>, or fewer
errors than <strong>Nr errors lesser than</strong> with <strong>Success when
number of errors lesser than</strong> (see the note below).</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
success condition is not met, for example because a source doesn’t exist,
a file can’t be moved, or the destination file exists and <strong>If
destination file exists</strong> is <strong>Fail</strong>. With <strong>Success
when all works fine</strong> or <strong>Success when number of errors lesser
than</strong>, the action stops once the condition is broken: the remaining
files are not moved. The number [...]
+</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>, every moved file is added,
with its destination path. A file left in place by <strong>Do nothing</strong>
is not added. With <strong>Simulate</strong>, nothing is moved but the
destination paths are still added.</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 source,
destination and wildcard come from the first three fields of each 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">
+With <strong>Success when number of errors lesser than</strong>, the action
stops and is false as soon as the number of errors reaches <strong>Nr errors
lesser than</strong>, but when the last file brings it to that number, the
action is still true. With <strong>If destination file exists</strong> set to
<strong>Fail</strong>, a file that already exists counts as two errors.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/shell.html
b/manual/next/workflow/actions/shell.html
index b2bbf7cd40..b90a607772 100644
--- a/manual/next/workflow/actions/shell.html
+++ b/manual/next/workflow/actions/shell.html
@@ -2975,10 +2975,9 @@
<div class="sect2">
<h3 id="_return_status"><a class="link" href="#_return_status">Return
status</a></h3>
<div class="paragraph">
-<p>The return status is provided by the operating system call.</p>
-</div>
-<div class="paragraph">
-<p>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.</p>
+<p>The return status is the exit code of the script or executable.
+An exit code of 0 means success; any other exit code makes the action fail.
+See <a href="#_result">Result</a>.</p>
</div>
<div class="paragraph">
<p>You can pass command line arguments and set up logging for the Shell
workflow action.</p>
@@ -3041,7 +3040,7 @@ When the field is left empty or the working directory is
invalid ${user.dir} wil
<td class="tableblock halign-left valign-top" colspan="2"><p
class="tableblock">Logging settings</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Specify
log file</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>
@@ -3087,7 +3086,7 @@ See also the logging window in .14 Logging</p></td>
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to arguments?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to args</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The
results from a previous pipeline can be sent to the shell script using the
"Copy rows to result" transform. (as arguments)</p></td>
</tr>
<tr>
@@ -3116,6 +3115,51 @@ The values of the corresponding result row can then be
found on command line arg
</div>
</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
command ended with exit code 0. 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
command ended with another exit code, or could not be started, for example
because the script file doesn’t exist on Linux or macOS. On Windows,
<code>cmd.exe</code> starts anyway and returns a non-zero exit code. The number
of errors is 1. 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">Passed on
unchanged, 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">Passed on
unchanged. With <strong>Copy previous results to args</strong>, the fields of
the result rows are passed as arguments: the fields of every row in a single
run, or with <strong>Execute for every result row</strong> the fields of the
current row in each run.</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">Exit
status: the exit code of the command; with <strong>Execute for every result
row</strong>, of the last run. It is not set when the command could not be
started.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>With <strong>Execute for every result row</strong> and no result rows, the
command doesn’t run, and the result of the previous action is passed on,
without an exit status.</p>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/zipfile.html
b/manual/next/workflow/actions/zipfile.html
index 2656c84354..76bf41bb0f 100644
--- a/manual/next/workflow/actions/zipfile.html
+++ b/manual/next/workflow/actions/zipfile.html
@@ -3139,6 +3139,56 @@ This is what will be taken from the rows.</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 zip
file was created or updated. It is also true when the zip exists and <strong>If
zip file exists</strong> is <strong>Do Nothing</strong>, which leaves it
unchanged, and when no file matches the wildcard with <strong>Include
sub-folders</strong> off, which creates an empty zip. With <strong>Include
sub-folders</strong> on, no match makes the action false and creates no
zip.</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 source
doesn’t exist, the zip exists and <strong>If zip file exists</strong> is
<strong>Fail</strong>, the zip can’t be written, or a source file
can’t be deleted with <strong>After zipping</strong>; the zip is already
created then. With <strong>After zipping</strong> set to <strong>Move
files</strong>, it is also false when the folder to move to doesn’t exist
and <strong>Create folder</strong [...]
+</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 Zip file to result</strong>, the zip file is added, also an
existing zip left unchanged by <strong>Do Nothing</strong>. A zip whose
creation fails is not added, but a zip that was created stays in the result
files even when the action ends up false.</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>Get arguments from previous</strong>, every result row
gives the source (first field), the include wildcard (second), the exclude
wildcard (third) and the zip file name (fourth). A row with an empty source or
zip file name is skipped. The first row that fails ends the action, which is
then false; the zips of the earlier rows stay, and are in the result files.
When every row is zipped, th [...]
+</tr>
+</tbody>
+</table>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+With an empty <strong>Source directory/file</strong>, or with <strong>Get
arguments from previous</strong> and no result rows, nothing is zipped and the
result of the previous action is passed on. A source file that can’t be
moved with <strong>After zipping</strong> set to <strong>Move files</strong> is
only logged: the action is still true, and the zip is in the result files.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
