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 63f4bfa848 Website updated to 2ff35d7
63f4bfa848 is described below
commit 63f4bfa8484d528a1ab43b7981b69e92bbb22b30
Author: jenkins <[email protected]>
AuthorDate: Wed Oct 28 13:33:23 2026 +0000
Website updated to 2ff35d7
---
manual/next/workflow/actions/dtdvalidator.html | 50 +++++++++++++++
manual/next/workflow/actions/evalfilesmetrics.html | 64 ++++++++++++++++---
.../workflow/actions/processresultfilenames.html | 64 +++++++++++++++++--
manual/next/workflow/actions/waitforfile.html | 47 ++++++++++++--
manual/next/workflow/actions/writetofile.html | 40 +++++++++++-
manual/next/workflow/actions/xmlwellformed.html | 71 +++++++++++++++++++---
6 files changed, 309 insertions(+), 27 deletions(-)
diff --git a/manual/next/workflow/actions/dtdvalidator.html
b/manual/next/workflow/actions/dtdvalidator.html
index 580766c4a5..3526e995dc 100644
--- a/manual/next/workflow/actions/dtdvalidator.html
+++ b/manual/next/workflow/actions/dtdvalidator.html
@@ -2991,6 +2991,56 @@
</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 XML
file is valid against the DTD.</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 XML
file does not follow the DTD: the number of errors is the number of validation
errors. The file or the DTD does not exist, <strong>DTD Intern</strong> is
selected and the file has no DOCTYPE, or the file is not well formed: the
number of errors is 0.</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.</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">
+The action reads the DOCTYPE of the file, which Hop refuses by default: the
variable <code>XML_ALLOW_DOCTYPE_DECL</code> is <code>N</code>. Set it to
<code>Y</code> (see <a href="../../variables.html" class="xref
page">Variables</a>), otherwise every file fails with "DOCTYPE is disallowed",
whether the DTD is internal or external.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/evalfilesmetrics.html
b/manual/next/workflow/actions/evalfilesmetrics.html
index 2793afd272..285dd17cdf 100644
--- a/manual/next/workflow/actions/evalfilesmetrics.html
+++ b/manual/next/workflow/actions/evalfilesmetrics.html
@@ -3006,15 +3006,15 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">File
Result field</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Previous result row</strong>: the name of the result row field that
holds the file or folder.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Wildcard
result field</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Previous result row</strong>: the name of the field that holds the
wildcard. Optional.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Include
subfolders result field</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Previous result row</strong>: the name of the field that says whether
to include subfolders (<code>Y</code> or <code>N</code>). Optional.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Evaluate</p></td>
@@ -3027,7 +3027,7 @@
<p>Total files size</p>
</li>
<li>
-<p>Total file count</p>
+<p>Total files count</p>
</li>
</ul>
</div></div></td>
@@ -3111,7 +3111,7 @@
<p>If value is equal to</p>
</li>
<li>
-<p>If value is equal to</p>
+<p>If value is different from</p>
</li>
<li>
<p>If value is small than</p>
@@ -3129,10 +3129,10 @@
<p>If value is between</p>
</li>
<li>
-<p>If value in list</p>
+<p>if value in list</p>
</li>
<li>
-<p>If value not in list</p>
+<p>if value not in list</p>
</li>
</ul>
</div></div></td>
@@ -3145,6 +3145,56 @@
</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 total
size (in the selected <strong>Scale</strong>) or the number of files meets the
<strong>Success when</strong> condition. Errors don’t change this: a path
that does not exist counts as an error, but with a total of 0 the condition can
still be met, and the action is then true with 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">The
condition is not met. The action also stops and is false, with 1 error, when
the Files/Folders list is empty, or with <strong>Previous result row</strong>
when the field set in <strong>File Result field</strong> is not in the result
rows.</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>Filenames result</strong>, the files evaluated are the
result files of the previous action whose whole name matches
<strong>Wildcard</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>Previous result row</strong>, the file or folder, the
wildcard and the include subfolders flag come from the result row fields named
in <strong>File Result field</strong>, <strong>Wildcard result field</strong>
and <strong>Include subfolders result field</strong>.</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>Filenames result</strong>, an invalid regular expression in
<strong>Wildcard</strong> stops the workflow with an error, and no hop is
followed.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/processresultfilenames.html
b/manual/next/workflow/actions/processresultfilenames.html
index 70b28d3ee4..246e406fdb 100644
--- a/manual/next/workflow/actions/processresultfilenames.html
+++ b/manual/next/workflow/actions/processresultfilenames.html
@@ -2953,7 +2953,7 @@
<h2 id="_description"><a class="link" href="#_description">Description</a></h2>
<div class="sectionbody">
<div class="paragraph">
-<p>The <code>Process result filenames</code> action allows you to copy, move
or delete a number of files and/or folders to alternate locations on your file
system.</p>
+<p>The <code>Process result filenames</code> action copies, moves or deletes
the result files of the previous actions in the workflow, for example the files
a pipeline wrote or a transfer action downloaded.</p>
</div>
</div>
</div>
@@ -2973,7 +2973,7 @@
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Workflow
action name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Action
name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The name
of the workflow action.</p></td>
</tr>
<tr>
@@ -3012,7 +3012,7 @@
<td class="tableblock halign-left valign-top"><p class="tableblock">use this
option to remove the processed filenames from the list of result
filenames</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Add
destination filenames to result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Add
destination filename to result</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">use this
option to add the processed target filenames to the list of result
filenames</p></td>
</tr>
<tr>
@@ -3043,7 +3043,7 @@
<td class="tableblock halign-left valign-top"><p class="tableblock">The
regular expression wildcard to use to include files</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Exclude
Wildcard (RegExp</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Exclude
wildcard (RegExp)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The
regular expression wildcard to use to exclude files</p></td>
</tr>
<tr>
@@ -3060,7 +3060,7 @@
<p>Success when all works fine</p>
</li>
<li>
-<p>Success when at least x files moved (specify x in the limit field below)</p>
+<p>Success when at least x files processed (specify x in the limit field
below)</p>
</li>
<li>
<p>Success when number of errors lesser than (specify the max number of errors
in the limit field below)</p>
@@ -3075,6 +3075,60 @@
</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
<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
processed with <strong>Success when at least x files processed</strong>, or no
more 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: a result file no longer exists on disk, or could
not be copied, moved or deleted. When the destination folder does not exist and
<strong>Create destination folder</strong> is not selected, the action stops
before processing any file, with 1 error. With <strong>Success when all works
fine</strong>, the action stops at the first error.</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 action
works on the result files of the previous actions, limited by <strong>Limit
action to</strong> and its wildcards. For each file copied or moved,
<strong>Remove source filenames from result</strong> removes the source and
<strong>Add destination filename to result</strong> adds the destination; both
are selected by default. <strong>Delete</strong> removes the deleted files from
the result files. A file whose de [...]
+</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>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
written</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files copied, moved or deleted. When the action stops because the
destination folder does not exist, the value of the previous action is passed
on.</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 is
still true when the number of errors equals <strong>Nr errors lesser
than</strong>. An invalid regular expression in <strong>Wildcard
(RegExp)</strong> or <strong>Exclude wildcard (RegExp)</strong> stops the
workflow with an error, and no hop is followed, also when <strong>Limit action
to</strong> is not selected.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/waitforfile.html
b/manual/next/workflow/actions/waitforfile.html
index 6707ee8ac9..4ed61a4998 100644
--- a/manual/next/workflow/actions/waitforfile.html
+++ b/manual/next/workflow/actions/waitforfile.html
@@ -3011,20 +3011,55 @@ A check cycle time of 30 or 60 seconds seems to be a
good trade-off between the
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Success on
timeout</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">This
option determines what to do when the "Maximum timeout" has been reached and
the file has not been found.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">This
option determines what to do when the "Maximum timeout" has been reached and
the file has not been found: when it is selected, the action is true and the
success hop is followed; otherwise the action is false.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">File size
check</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">When this
is switched on, once the workflow action detects the specified file, and will
only continue if the file size hasn’t changed the last check "cycle time
seconds".
This is useful in cases where a file is created in the final place, and
another process is still writing to the file.
-(As a best practice, files should be written to a temporary location, and then
moved when completed)
-This is the number seconds after which the flow will continue even if the file
was not created.
-When the timeout is reached the "Success on timeout" option will determine
whether the outgoing success or failure hop will be followed.
-If enabled, the workflow action will evaluate successfully, and the outgoing
success hop will be followed.</p></td>
+(As a best practice, files should be written to a temporary location, and then
moved when completed)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Add
filename to result</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Add the
filename to the result fields for this workflow action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Add the
file to the result files of this action. See <a
href="#_result">Result</a>.</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, or appears before <strong>Maximum timeout</strong>. With
<strong>Success on timeout</strong>, the action is also true when the timeout
is reached without it. With <strong>File size check</strong>, the action first
waits until the size stays the same between two checks. A <strong>Maximum
timeout</strong> of 0 waits until the file appears or the workflow is
stopped.</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
timeout is reached without the file and <strong>Success on timeout</strong> is
not selected, no file name is set, the path cannot be read (for example a
<code>zip:</code> path into a file that is not a zip), or the workflow is
stopped while waiting. The number of errors is always 0.</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 when it is found. A
folder is not added, and nothing is added when the action ends on the timeout.
The result files of the previous action 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">Passed on
unchanged.</p></td>
</tr>
</tbody>
</table>
diff --git a/manual/next/workflow/actions/writetofile.html
b/manual/next/workflow/actions/writetofile.html
index 567d4d32da..55c7dc7cc9 100644
--- a/manual/next/workflow/actions/writetofile.html
+++ b/manual/next/workflow/actions/writetofile.html
@@ -2953,7 +2953,7 @@
<h2 id="_description"><a class="link" href="#_description">Description</a></h2>
<div class="sectionbody">
<div class="paragraph">
-<p>The <code>Write to file</code> action writes custom text from a field to a
file.</p>
+<p>The <code>Write to file</code> action writes the text you enter in the
action to a file. Variables in the text are resolved.</p>
</div>
</div>
</div>
@@ -3009,6 +3009,44 @@
</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 text
was written to the file.</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">No file
name is set, the parent folder does not exist and <strong>Create parent
folder</strong> is not selected, the file cannot be written (for example in a
read-only folder), or the encoding is not known. 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. The written 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/xmlwellformed.html
b/manual/next/workflow/actions/xmlwellformed.html
index 22ce46b003..77d0da24c7 100644
--- a/manual/next/workflow/actions/xmlwellformed.html
+++ b/manual/next/workflow/actions/xmlwellformed.html
@@ -2979,12 +2979,12 @@
<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">Include
Subfolders</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Option to
move the content of sub-folders.</p></td>
+<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 check
the matching files in the subfolders of a folder.</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">Check this
to pass the results of the previous action into the arguments of this
action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Take the
files or folders and wildcards from the result rows of the previous action
instead of from the list. See <a href="#_result">Result</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">File/Folder source</p></td>
@@ -2992,13 +2992,13 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Wildcard
(RegExp)</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">A regular
expression wildcard for the filename pattern</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A regular
expression matched against the whole path of each file in the folder, for
example <code>.*\.xml</code> (see <a href="#_result">Result</a>).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Files/Folders</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
<p>Specify the list of files or folders with wildcards (regular expressions)
in this grid.
-You can add a different source/destination on each line.</p>
+You can add a different file or folder and wildcard on each line.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -3018,9 +3018,6 @@ You can use the Add button to add a line to the
Files/Folders list.
</div>
<div class="sect2">
<h3 id="_advanced_tab"><a class="link" href="#_advanced_tab">Advanced
tab</a></h3>
-<div class="paragraph">
-<p>In this tab you can specify the files and/or folders to move.</p>
-</div>
<table class="tableblock frame-all grid-all" style="width: 90%;">
<colgroup>
<col style="width: 25%;">
@@ -3070,6 +3067,64 @@ You can use the Add button to add a line to the
Files/Folders list.
</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: every file well formed with
<strong>Success if all files are well formed</strong>, at least <strong>Nr
files</strong> well formed files with <strong>Success if at least x files are
well formed</strong>, or fewer bad formed files than <strong>Nr files</strong>
with <strong>Success when number of bad formed files lesser than</strong>. The
number of errors is then 0.</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. A bad formed file counts as an error and does not
stop the action. A path that does not exist counts as an error; with
<strong>Success if all files are well formed</strong>, it stops the action, and
the remaining entries are not 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"><strong>Add all filenames</strong> (the default) adds every
file checked, <strong>Add only well formed filenames</strong> only the well
formed ones, and <strong>Add only bad formed filenames</strong> only the bad
formed ones. The result files of the previous action 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">Passed on
unchanged. With <strong>Copy previous results to args</strong>, the file or
folder and the wildcard come from the first two fields of each result
row.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
written</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of well formed files.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
rejected</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of bad formed files.</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">
+A result row with fewer than two fields stops the workflow with an error, and
no hop is followed. The wildcard is matched against the whole path of each file
(for example <code><a href="file:///data/in/orders.xml"
class="bare">file:///data/in/orders.xml</a></code>), not its name:
<code>.*\.xml</code> matches, <code>orders\.xml</code> matches nothing, and the
action is still true.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
