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 82e1433b21 Website updated to b04100c
82e1433b21 is described below
commit 82e1433b21028d58d040849e17f63476ff2ceabe
Author: jenkins <[email protected]>
AuthorDate: Mon Nov 2 14:56:57 2026 +0000
Website updated to b04100c
---
.../pipeline/transforms/enhancedjsonoutput.html | 24 +++++++-
.../actions/check-graph-database-connections.html | 38 +++++++++++++
.../workflow/actions/create-property-graph.html | 62 ++++++++++++++++++++
.../next/workflow/actions/deleteexecutioninfo.html | 66 ++++++++++++++++++++++
manual/next/workflow/actions/ftp.html | 6 +-
manual/next/workflow/actions/ftpdelete.html | 6 +-
manual/next/workflow/actions/graph-constraint.html | 66 +++++++++++++++++++++-
manual/next/workflow/actions/graph-index.html | 64 ++++++++++++++++++++-
manual/next/workflow/actions/graph-script.html | 62 ++++++++++++++++++--
manual/next/workflow/actions/runpipelinetests.html | 44 ++++++++++++++-
.../workflow/actions/sendnagiospassivecheck.html | 64 ++++++++++++++++++---
.../next/workflow/actions/setpasswordencoder.html | 50 ++++++++++++++++
manual/next/workflow/actions/snmptrap.html | 58 +++++++++++++++++--
13 files changed, 580 insertions(+), 30 deletions(-)
diff --git a/manual/next/pipeline/transforms/enhancedjsonoutput.html
b/manual/next/pipeline/transforms/enhancedjsonoutput.html
index 4fd71a0db1..4da7c0fc3c 100644
--- a/manual/next/pipeline/transforms/enhancedjsonoutput.html
+++ b/manual/next/pipeline/transforms/enhancedjsonoutput.html
@@ -3300,7 +3300,29 @@ You can use this option (and a chain of transforms, see
the example pipeline in
<h2 id="_notes"><a class="link" href="#_notes">Notes</a></h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Look at the sample provided
<em>json-output-generate-nested-structure.hpl</em> for a better understanding
about how the transform works</p>
+<p>The sample <code>json-output-generate-nested-structure.hpl</code> builds a
nested document with two Enhanced JSON Output transforms.
+Sort rows orders the input by <code>field1</code> descending, then
<code>field2</code> ascending, so the <code>C</code> group comes first.
+The first transform groups by <code>field1</code> and writes
<code>field2</code> and <code>field3</code> as <code>campo2</code> and
<code>campo3</code> into the field <code>lvl1Details</code>.
+The second transform has no group key.
+It writes <code>field1</code> as <code>campo1</code> and embeds
<code>lvl1Details</code> as <code>details</code>, under the block name
<code>results</code>.</p>
+</div>
+<div class="paragraph">
+<p>With no group key and Force single grouped item unchecked, the output is an
array with one object per row.
+A single row gives one object unless Force arrays in JSON is checked.
+With Force single grouped item and no group key, every row counts as the same
group, so the rows merge into one object with an array per field.
+A JSON block name wraps that value in an object.
+The sample’s second transform does this with <code>results</code>.
+Grouped items require a group key, and the input has to be sorted by every
group key.
+The Group Key section above shows that file shape.</p>
+</div>
+<div class="paragraph">
+<p>The sample writes this value.
+<code>campo3</code> is a string because the Data Grid defines
<code>field3</code> as String.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<div class="code-lang" data-pagefind-ignore>json</div><pre class="highlightjs
highlight is-highlighted"><code class="language-json hljs"
data-lang="json"><span class="hljs-punctuation">{</span><span
class="hljs-attr">"results"</span><span
class="hljs-punctuation">:</span><span class="hljs-punctuation">[</span><span
class="hljs-punctuation">{</span><span
class="hljs-attr">"campo1"</span><span
class="hljs-punctuation">:</span><span class="hljs-string">"C"</spa
[...]
+</div>
</div>
</div>
</div>
diff --git a/manual/next/workflow/actions/check-graph-database-connections.html
b/manual/next/workflow/actions/check-graph-database-connections.html
index db76a2fe5c..365b3c2b17 100644
--- a/manual/next/workflow/actions/check-graph-database-connections.html
+++ b/manual/next/workflow/actions/check-graph-database-connections.html
@@ -2997,6 +2997,44 @@ This action does not (yet) retrieve the list of
connections. You really need to
</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">Every
connection of the list was found and answered, with 0 errors. An empty list is
also true.</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 number
of errors is the number of connections that failed: a name that is empty or
doesn’t exist, a server that can’t be reached, or a login that is
refused. All the connections are checked, also after one that fails.</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>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/create-property-graph.html
b/manual/next/workflow/actions/create-property-graph.html
index 5e8d1950bb..8e9a13c1c3 100644
--- a/manual/next/workflow/actions/create-property-graph.html
+++ b/manual/next/workflow/actions/create-property-graph.html
@@ -3143,6 +3143,68 @@ Create that connection, or select your own in the action
and in both pipelines.<
</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
property graph was created, with 0 errors, and with <strong>Create missing
tables?</strong> the tables that didn’t exist yet. Tables that already
exist are kept as they are. With <strong>Replace an existing graph?</strong> an
existing graph with the same name is replaced.</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 number
of errors is 1. <strong>Property graph name</strong> is empty or holds a
character that can’t be quoted (for example <code>"</code>), the
<strong>Graph model</strong> doesn’t exist, the database can’t be
reached or doesn’t support SQL/PGQ, the <strong>Schema</strong>
doesn’t exist, a table is missing while <strong>Create missing
tables?</strong> is unchecked, or the graph already [...]
+</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+A <strong>Relational database connection</strong> that is empty or
doesn’t exist doesn’t make the action false: the workflow stops
with an error, and no hop from the action is followed.
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+The tables are created before the property graph. When the <code>CREATE
PROPERTY GRAPH</code> statement fails, for example on a database without
SQL/PGQ, the tables it created stay.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/deleteexecutioninfo.html
b/manual/next/workflow/actions/deleteexecutioninfo.html
index 76161739e5..31398e4e65 100644
--- a/manual/next/workflow/actions/deleteexecutioninfo.html
+++ b/manual/next/workflow/actions/deleteexecutioninfo.html
@@ -3007,6 +3007,72 @@
<p>An execution with no start date is deleted together with the ones that are
old enough. Children of a deleted execution are removed with it.</p>
</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
executions were deleted, with 0 errors. No execution to delete, or a root
folder that doesn’t exist yet, is also true. The result is not used for
hops: see the WARNING.</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 number
of errors is 1. <strong>Execution information location</strong> is empty or
doesn’t exist, <strong>Older than</strong> is empty, 0, negative or not a
number while <strong>Delete all executions in this location</strong> is
unchecked, or an execution can’t be deleted (for example a read-only
folder).</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>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of executions deleted. A File location counts each run once, with everything it
ran (child pipelines, actions, transforms). A Caching file location counts the
workflow and each pipeline it ran separately. When the action is false, the
value of the previous action is passed on.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+A success or failure hop from this action is never followed, whatever the
result: only an unconditional hop is. The result and the metrics are still
passed on to the next action.
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+A Caching file location only deletes the executions of the project the
workflow runs in, when both have a project id: an execution stored without
project id is deleted from any project, and a workflow that runs in a project
without project id deletes the executions of every project. A File location
deletes the executions of every project that writes to it.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/ftp.html
b/manual/next/workflow/actions/ftp.html
index 75a7e66880..8b365b788c 100644
--- a/manual/next/workflow/actions/ftp.html
+++ b/manual/next/workflow/actions/ftp.html
@@ -3169,7 +3169,7 @@ For example: .txt$ : get all text files A.ENG:0-9.txt :
files starting with A, e
<p>At least we got x files</p>
</li>
<li>
-<p>Nr errors less than</p>
+<p>Nr errors at most</p>
</li>
</ul>
</div></div></td>
@@ -3248,14 +3248,14 @@ For example: .txt$ : get all text files A.ENG:0-9.txt :
files starting with A, e
<p>At least we got x files: at least <strong>Limit files</strong> files were
downloaded, whatever the number of errors.</p>
</li>
<li>
-<p>Nr errors less than: the number of errors is at most <strong>Limit
files</strong>. The download stops as soon as the number of errors reaches
<strong>Limit files</strong>, and the action is still true then. Some failures
before the download also count as 1 error: see False.</p>
+<p>Nr errors at most: after the action is ready to download files, the number
of errors is at most <strong>Limit files</strong>. The download stops as soon
as the number of errors reaches <strong>Limit files</strong>, and the action is
still true then.</p>
</li>
</ul>
</div></div></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. Without <strong>Nr errors less than</strong>, the
download stops at the first file that fails. The action is also false, before
any download, when the server can’t be reached or refuses the login, the
remote directory doesn’t exist, the wildcard is not a valid regular
expression, or <strong>Move files after retrieval</strong> is checked while the
move-to folder is empty, or d [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
success condition is not met. With <strong>All works fine</strong>, the
download stops at the first file that fails. With <strong>At least we got x
files</strong>, the download walks the whole list and checks the downloaded
count at the end. The action is also false, whatever the success condition,
when it fails before any download: the server can’t be reached or refuses
the login, the remote directory doesn [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Errors</p></td>
diff --git a/manual/next/workflow/actions/ftpdelete.html
b/manual/next/workflow/actions/ftpdelete.html
index c45ee3b259..a29569619b 100644
--- a/manual/next/workflow/actions/ftpdelete.html
+++ b/manual/next/workflow/actions/ftpdelete.html
@@ -3144,7 +3144,7 @@ The default is Passive mode.</p></td>
<p>At least we delete x files</p>
</li>
<li>
-<p>Nr errors less than</p>
+<p>Nr errors at most</p>
</li>
</ul>
</div></div></td>
@@ -3223,14 +3223,14 @@ The default is Passive mode.</p></td>
<p>At least we delete x files: at least <strong>Limit files</strong> files
were deleted.</p>
</li>
<li>
-<p>Nr errors less than: the number of errors is at most <strong>Limit
files</strong>. A failure before deleting counts as 1 error, so the cases
listed under False give true with 1 error when <strong>Limit files</strong> is
1 or more.</p>
+<p>Nr errors at most: after the action is ready to delete files, the number of
errors is at most <strong>Limit files</strong>. The delete stops as soon as the
number of errors reaches <strong>Limit files</strong>, and the action is still
true then.</p>
</li>
</ul>
</div></div></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 the server can’t be
reached or refuses the login, the remote directory doesn’t exist, the
wildcard is not a valid regular expression, or <strong>Wildcard</strong> is
empty while <strong>Copy previous results to args</strong> is unchecked. The
number of errors is the number of files that failed, or 1 when the action fails
before deleting. With <strong>Nr er [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
success condition is not met. With <strong>All works fine</strong>, the delete
stops at the first file that fails. With <strong>At least we delete x
files</strong>, the delete runs to the end of the list and checks the deleted
count at the end. The action is also false, whatever the success condition,
when it fails before deleting: the server can’t be reached or refuses the
login, the remote directory doesnR [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
diff --git a/manual/next/workflow/actions/graph-constraint.html
b/manual/next/workflow/actions/graph-constraint.html
index 66cea2edfd..2b64827cf9 100644
--- a/manual/next/workflow/actions/graph-constraint.html
+++ b/manual/next/workflow/actions/graph-constraint.html
@@ -2994,7 +2994,7 @@
<p>Update type : CREATE or DROP</p>
</li>
<li>
-<p>Type of object to index on: NODE or RELATIONSHIP</p>
+<p>Type of object to put constraint on: NODE or RELATIONSHIP</p>
</li>
<li>
<p>Type of constraint: UNIQUE, NOT_NULL, or NODE_KEY</p>
@@ -3006,7 +3006,7 @@
<p>Object name: the label of the node or relationship you want to update a
constraint for</p>
</li>
<li>
-<p>Property: the property to put the constraint on (for NODE_KEY, use
comma-separated properties like "id,name")</p>
+<p>Object property: the property to put the constraint on (for NODE_KEY, use
comma-separated properties like "id,name")</p>
</li>
</ul>
</div>
@@ -3046,6 +3046,68 @@ shows the exact <code>CREATE CONSTRAINT</code> or
<code>DROP CONSTRAINT</code> s
including the correct syntax for UNIQUE, NOT_NULL, and NODE_KEY
constraints.</p>
</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">All the
constraint updates ran, with 0 errors. The drops run first, then the creates.
An empty list is also true.</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 action
is never false: see the WARNING.</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+When a constraint update can’t be done, the workflow stops with an error
and no hop from the action is followed: the <strong>Graph database
connection</strong> is empty, doesn’t exist or can’t be reached, an
update has no <strong>Update type</strong> (a blank type comes back as CREATE
when the workflow is loaded from its file), on Neo4j <strong>Constraint
name</strong> is empty or a create has no <strong>Object property</strong> (a
drop only uses the name), on Memgraph, [...]
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+On Neo4j the action creates with <code>IF NOT EXISTS</code> and drops with
<code>IF EXISTS</code>. Creating a constraint that already exists, or dropping
one that doesn’t, does nothing and the action is still true. This is also
the case when a constraint with the same name exists on another label or
property, or an equivalent one exists with another name: nothing is created.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/graph-index.html
b/manual/next/workflow/actions/graph-index.html
index 57a81bc9dd..e4b4d4730b 100644
--- a/manual/next/workflow/actions/graph-index.html
+++ b/manual/next/workflow/actions/graph-index.html
@@ -3003,7 +3003,7 @@
<p>Object name: the label of the node or relationship you want to update an
index for</p>
</li>
<li>
-<p>Properties: the comma separated list of node or relationship properties to
index</p>
+<p>Properties (, separated): the comma separated list of node or relationship
properties to index</p>
</li>
<li>
<p>Index type: RANGE for a regular property index (the default), VECTOR for a
vector index</p>
@@ -3131,6 +3131,68 @@ shows the exact <code>CREATE INDEX</code> or <code>DROP
INDEX</code> statements
<p>The preview is read-only and helps you verify the index operations that
will be performed.</p>
</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">All the
index updates ran, with 0 errors. The drops run first, then the creates. An
empty list is also true. An empty <strong>Index name</strong> is only fine
where the database doesn’t use names: to create a RANGE index on Neo4j,
which then names the index, for range indexes on Memgraph, and for every index
on FalkorDB. In the other cases it stops the workflow, see the WARNING.</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 action
is never false: see the WARNING.</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+When an index update can’t be done, the workflow stops with an error and
no hop from the action is followed: the <strong>Graph database
connection</strong> is empty, doesn’t exist or can’t be reached, an
update has no <strong>Update type</strong>, an index is created without
<strong>Object name</strong> or <strong>Properties</strong> (on Memgraph and
FalkorDB, which identify an index by them, also when it is dropped, except a
Memgraph vector index), a VECTOR index is cr [...]
+</td>
+</tr>
+</table>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+On Neo4j and Apache AGE the action creates with <code>IF NOT EXISTS</code> and
drops with <code>IF EXISTS</code>. Creating an index that already exists, or
dropping one that doesn’t, does nothing and the action is still true. On
Neo4j this is also the case when an index with the same name exists on another
label or property, or an equivalent one exists with another name: nothing is
created.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/graph-script.html
b/manual/next/workflow/actions/graph-script.html
index 7fad4bc0ae..e5153127c7 100644
--- a/manual/next/workflow/actions/graph-script.html
+++ b/manual/next/workflow/actions/graph-script.html
@@ -2975,7 +2975,7 @@
</div>
<div class="paragraph">
<p>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.<br>
-The result of this action is a <code>true</code> or <code>false</code> exit
code that determines if a success or failure hop to the next action in the
workflow is chosen.</p>
+The result of this action is a <code>true</code> or <code>false</code> exit
code that determines if a success or failure hop to the next action in the
workflow is chosen, except when the connection can’t be used: see <a
href="#_result">Result</a>.</p>
</div>
</div>
</div>
@@ -3018,16 +3018,16 @@ The script then no longer runs in a single transaction:
when a statement fails,
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Connection
name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Graph
database connection</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The name
of the connection on which you want to execute the cypher statements.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p
class="tableblock">Script</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Cypher
Script</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The script
with cypher commands separated by a semi-colon (;) on a new line.
For examples see below.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Replace
variables</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Replace
variables in script?</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Check this
option if you want to replace variables in the format
<code>${VARIABLE_NAME}</code> in the script prior to execution.</p></td>
</tr>
</tbody>
@@ -3039,13 +3039,63 @@ For examples see below.</p></td>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-CREATE INDEX
idx_person_name on :Person(name) hljs" data-lang="CREATE INDEX idx_person_name
on :Person(name)">CREATE INDEX idx_company_id on :Company(id)
+<div class="code-lang" data-pagefind-ignore>cypher</div><pre
class="highlightjs highlight"><code class="language-cypher hljs"
data-lang="cypher">CREATE INDEX idx_person_name IF NOT EXISTS FOR (n:Person) ON
(n.name)
;
-CREATE INDEX idx_company_id on :Company(id)
+CREATE INDEX idx_company_id IF NOT EXISTS FOR (n:Company) ON (n.id)
;</code></pre>
</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">All the
statements ran, with 0 errors. An empty script is also true. A query that
returns rows is true too: the rows are not passed on.</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 number
of errors is 1. A statement fails, for example invalid Cypher, a semicolon at
the end of a line instead of on a new line (Neo4j then gets two statements as
one), or on Neo4j index or constraint changes and data changes in the same
script, in either order (<code>Tried to execute Write query after executing
Schema modification</code>, or the other way around). See <a
href="#_transactions">Transactions</a> for th [...]
+</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+A <strong>Graph database connection</strong> that is empty, doesn’t
exist, can’t be reached or refuses the login doesn’t make the
action false: the workflow stops with an error, and no hop from the action 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/runpipelinetests.html
b/manual/next/workflow/actions/runpipelinetests.html
index 1dbc8bafe4..31c70a7361 100644
--- a/manual/next/workflow/actions/runpipelinetests.html
+++ b/manual/next/workflow/actions/runpipelinetests.html
@@ -2985,12 +2985,12 @@
</thead>
<tbody>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">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 action.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Test
names</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The names
of the unit tests to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Names of
the tests to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The names
of the unit tests to execute.</p></td>
</tr>
</tbody>
</table>
@@ -2998,6 +2998,44 @@
<p>Use the <code>Get test names</code> to get the list of available unit tests
in the current project.</p>
</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">Every test
in the list ran its pipeline without errors and the golden data sets matched,
with 0 errors. An empty list is also true.</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 number
of errors is 1. A test is not found (an unknown or empty name), its pipeline
file is not found, the pipeline fails, or the rows don’t match a golden
data set. All the tests of the list are run, also after one that fails.</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: the rows that a test pipeline copies to its result are not
added.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/sendnagiospassivecheck.html
b/manual/next/workflow/actions/sendnagiospassivecheck.html
index d5252801b4..81c89b6c50 100644
--- a/manual/next/workflow/actions/sendnagiospassivecheck.html
+++ b/manual/next/workflow/actions/sendnagiospassivecheck.html
@@ -2998,12 +2998,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">Host
Name/IP Address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Host
name/IP address</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Nagios
server name / IP Address</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Server
port</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Nagios
server port (often 5667).</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Nagios
server port (default 5667). A value that is not a number is replaced by 5667; a
number that is not a valid port (for example 70000) makes the action
false.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Password</p></td>
@@ -3011,7 +3011,7 @@
This field can be set empty when connections without password are
allowed.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Connection
Timeout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Connection
timeout</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Fail after
the specified connection timeout in milliseconds (default 5000).</p></td>
</tr>
<tr>
@@ -3022,12 +3022,12 @@ This field can be set empty when connections without
password are allowed.</p></
<td class="tableblock halign-left valign-top" colspan="2"><p
class="tableblock">Sender</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Host
Name/IP Address</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Define
your sender host name / IP Address.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Name/ IP
host</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Define
your sender host name / IP Address. When it is empty, the name of the machine
that runs the workflow is sent.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Service
Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Define the
service name used to log the events.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Service
name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Define the
service name used to log the events. When it is empty, <code>UNDEFINED</code>
is sent.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Encryption
mode</p></td>
@@ -3077,6 +3077,56 @@ This field can be set empty when connections without
password are allowed.</p></
</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
passive check was sent to the NSCA server, with 0 errors. The action sends the
check and closes the connection without waiting for an answer.</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 number
of errors is 1. <strong>Host name/IP address</strong> or
<strong>Message</strong> is empty, the host name can’t be resolved,
<strong>Server port</strong> is a number that is not a valid port, the server
refuses the connection or doesn’t answer it within <strong>Connection
timeout</strong>, or the server doesn’t send its first packet within
<strong>Response timeout</strong>.</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+Since Hop 2.18 the action can’t send a check: the library it uses
(jsendnsca) needs <code>commons-lang</code> 2, which Hop no longer ships. The
workflow stops with <code>NoClassDefFoundError:
org/apache/commons/lang/Validate</code>, and no hop from the action is
followed. Only an empty <strong>Host name/IP address</strong> or
<strong>Message</strong> still makes the action false. The table above
describes the action with that library available (tested with
<code>commons-lang-2.6.ja [...]
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/setpasswordencoder.html
b/manual/next/workflow/actions/setpasswordencoder.html
index d51fab2468..ba1160b4b4 100644
--- a/manual/next/workflow/actions/setpasswordencoder.html
+++ b/manual/next/workflow/actions/setpasswordencoder.html
@@ -3038,6 +3038,56 @@
</ul>
</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
encoder was initialized, with 0 errors. An empty <strong>Encoder plugin
ID</strong> initializes <code>Hop</code>. An <strong>Encoder plugin ID</strong>
that doesn’t exist is also true: see the NOTE.</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 number
of errors is 1. <strong>Encoder plugin ID</strong> resolves to an empty value
(for example an empty variable), or <code>AES</code> or <code>AES2</code> finds
no key: the variable named in <strong>Key variable name</strong> is empty,
<code>HOP_AES_ENCODER_KEY</code> is not set either, and <strong>Key file
path</strong> is empty or the file doesn’t exist.</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">
+An <strong>Encoder plugin ID</strong> that doesn’t exist only logs an
error (<code>Unable to find two-way password encoder plugin with ID
…​</code>): the <code>Hop</code> encoder is used instead, and the
action is true and logs that it initialized the ID it was given.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/snmptrap.html
b/manual/next/workflow/actions/snmptrap.html
index f5dc2f98a5..4328c5faea 100644
--- a/manual/next/workflow/actions/snmptrap.html
+++ b/manual/next/workflow/actions/snmptrap.html
@@ -2991,7 +2991,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Server
port</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The server
port.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The server
port (default 162). A value that is not a number is replaced by 162; a number
that is not a valid port (for example 70000) makes the action false.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">OID</p></td>
@@ -3006,11 +3006,11 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target
type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type of
target: Community or User.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of
target: Community (SNMP V1) or User (SNMP V3). See the WARNING under <a
href="#_result">Result</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Community
string</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">A user id
or password that allows access to a router’s or other device’s
statistics.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A user id
or password that allows access to a router’s or other device’s
statistics (default <code>public</code>).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">User</p></td>
@@ -3022,7 +3022,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Engine
ID</p></td>
-<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
context engine ID of the SNMP V3 trap (optional).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Retry</p></td>
@@ -3042,6 +3042,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 trap
was sent, with 0 errors. The action doesn’t wait for an answer, so it is
also true when nothing listens on <strong>Server port</strong>. An empty
<strong>Server name / IP address</strong> sends the trap to the local machine,
and an empty <strong>OID</strong> or <strong>Message</strong> is sent as it
is.</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 number
of errors is 1. <strong>Server name / IP address</strong> can’t be
resolved, <strong>Server port</strong> is a number that is not a valid port
(for example 70000), or <strong>OID</strong> is not a valid object identifier
(for example <code>abc</code>).</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 warning">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-warning" title="Warning"></i>
+</td>
+<td class="content">
+<strong>User (SNMP V3)</strong> is not kept. When the workflow is loaded from
its file, the target type is read back as <strong>Community (SNMP V1)</strong>,
so the action sends an SNMP V1 trap with <strong>Community string</strong>, and
<strong>User</strong>, <strong>Passphrase</strong> and <strong>Engine
ID</strong> are not used.
+</td>
+</tr>
+</table>
+</div>
+</div>
</div>
</article>
<nav class="pagination" data-pagefind-ignore aria-label="Page">