This is an automated email from the ASF dual-hosted git repository.

hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git


The following commit(s) were added to refs/heads/main by this push:
     new 7e3c2c9510 Batch 14: Result sections for MongoDB QL, Build 
documentation, Databricks job wait, Snowflake warehouse manager and AS/400 
command. #8970 (#9217)
7e3c2c9510 is described below

commit 7e3c2c95104b92d622cef24a3ddf0ed625d660fd
Author: Adalennis <[email protected]>
AuthorDate: Mon Nov 2 16:11:09 2026 +0100

    Batch 14: Result sections for MongoDB QL, Build documentation, Databricks 
job wait, Snowflake warehouse manager and AS/400 command. #8970 (#9217)
---
 .../ROOT/pages/workflow/actions/as400command.adoc  | 19 +++++++++--
 .../workflow/actions/databricks-job-wait.adoc      | 25 +++++++++++---
 .../ROOT/pages/workflow/actions/documentation.adoc | 30 +++++++++++------
 .../modules/ROOT/pages/workflow/actions/mql.adoc   | 22 ++++++++++--
 .../ROOT/pages/workflow/actions/snowflake-whm.adoc | 39 +++++++++++++++-------
 5 files changed, 102 insertions(+), 33 deletions(-)

diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
index 3fe3e50aab..d81aab1961 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/as400command.adoc
@@ -33,9 +33,22 @@ The `AS/400 command` action executes an AS/400 CL Command.
 |Server|Host name or IP address.
 |User name|The user name associated with AS/400 server account.
 |Password|The password associated the AS/400 server account.
-|Proxy host|Proxy server host name or IP address.
-|Proxy port|Proxy server port number.
+|Host name (Proxy)|Proxy server host name or IP address.
+|Port (Proxy)|Proxy server port number.
 |Command to call|The command to run on the AS/400. If the command is not 
library qualified, the library list will be used to find the command.
 |===
 
-NOTE: This plugin tries to load the as400 library from the as400 database 
plugin.
\ No newline at end of file
+NOTE: This plugin tries to load the as400 library from the as400 database 
plugin.
+
+== Result
+
+What this action passes on to the next action. See 
xref:workflow/action-results.adoc[Action results] for how results travel 
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The command ran successfully, with 0 errors.
+|False|The number of errors is 1. The server can't be reached or refuses the 
login, or the command fails. When the command fails, the messages it returns 
(message ID, text and help) are logged.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/databricks-job-wait.adoc
 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/databricks-job-wait.adoc
index b18a3b46ba..af17aeefc6 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/databricks-job-wait.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/databricks-job-wait.adoc
@@ -47,14 +47,14 @@ For “submit and block on this step,” use Job Run’s built-in 
**Wait for com
 |Run ID
 |Numeric run id; default `+${DatabricksRunId}+`
 
-|Timeout (seconds)
-|Maximum wait; `0` = no timeout
+|Timeout (seconds, 0=none)
+|Maximum wait; `0` = no timeout. A value that is not a number is replaced by 
3600.
 
 |Poll interval (seconds)
-|Delay between status checks (default 15)
+|Delay between status checks (default 15, at least 1)
 
-|Cancel run if workflow is stopped
-|If checked, calls `jobs/runs/cancel` when the parent workflow stops
+|Cancel Databricks run if workflow is stopped
+|If checked, calls `jobs/runs/cancel` when the parent workflow stops, and also 
when the timeout is reached
 
 |Result variables
 |Same defaults as Job Run: `DatabricksJobId`, `DatabricksRunId`, 
`DatabricksStatus`, `DatabricksRunPageUrl`, `DatabricksError`
@@ -65,3 +65,18 @@ For “submit and block on this step,” use Job Run’s built-in 
**Wait for com
 * xref:workflow/actions/databricks-job-run.adoc[Databricks job run]
 * xref:pipeline/spark/databricks.adoc[Native Spark on Databricks]
 * xref:metadata-types/databricks-connection.adoc[Databricks Connection]
+
+== Result
+
+What this action passes on to the next action. See 
xref:workflow/action-results.adoc[Action results] for how results travel 
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The run ended with life cycle state `TERMINATED` and result state 
`SUCCESS`, with 0 errors.
+|False|The number of errors is 1. *Databricks connection* is empty or doesn't 
exist, *Run ID* is empty or not a number, a call to the Jobs API fails, the run 
ends with another result state (for example `FAILED` or `CANCELED`) or with 
life cycle state `SKIPPED` or `INTERNAL_ERROR`, the timeout is reached, or the 
workflow is stopped while the action waits.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+NOTE: After every status check the action sets the result variables for the 
Job ID, the Run ID, the status (the result state, like `SUCCESS` or `FAILED`, 
once the run is `TERMINATED`, the life cycle state before that) and the run 
page URL (the Job ID and the URL only when Databricks returns them), in its 
workflow and in every parent workflow. The error variable is emptied when the 
action starts and holds the error message when the action is false, except for 
a canceled run: then it stays empty.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/documentation.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/documentation.adoc
index 7d99fa6843..750174e458 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/documentation.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/documentation.adoc
@@ -27,20 +27,30 @@ This action builds documentation of your Hop files or 
project.
 
 == Options
 
-* The target folder in which you want your project documentation to end up in.
-* Include notes?
-* Include parameters?
+* The target folder: the folder in which you want your project documentation 
to end up in.
+* Include notes text?
+* List parameters?
 * Include metadata?
 * Generate HTML?
-* Remove MarkDown after HTML is generated?
+* Remove MarkDown files?: only when *Generate HTML?* is checked, removes the 
MarkDown files after the HTML is generated.
 
 == Generating HTML from MarkDown
 
-The links from the index are currently set to the .md.html files.
-I ran the following command in the target folder to generate the HTML files:
+With *Generate HTML?* the action writes an HTML file next to each MarkDown 
file, and the HTML index links to the HTML files. With *Remove MarkDown files?* 
the MarkDown files are removed and the HTML files, the images and the styles 
stay.
 
-[source,bash]
-----
-for i in $(find . -name '*.md') ; do echo "$i" && pandoc -s $i -c 
assets/styles.css -o $i.html ; done
-----
+== Result
 
+What this action passes on to the next action. See 
xref:workflow/action-results.adoc[Action results] for how results travel 
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The documentation of the project folder was written to the target 
folder. The action doesn't set its own result: it passes on the result of the 
previous action, see the WARNING.
+|False|The number of errors is 1. The target folder is empty, is a file, or 
can't be written, or a file of the project can't be read (for example a 
pipeline file that is not valid XML). The files written before the error stay: 
the documentation is left incomplete.
+|Result files|Passed on unchanged: the documentation files are not added.
+|Result rows|Passed on unchanged.
+|===
+
+WARNING: When the documentation is written, the action keeps the result of the 
previous action. After a false action on an unconditional or failure hop, it is 
false although the documentation was written.
+
+NOTE: Files that are already in the target folder stay.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
index 5ed60167a8..5c5e8c8f71 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
@@ -43,8 +43,7 @@ MongoDB documentation : 
https://www.mongodb.com/docs/manual/reference/command/
 |Use external file|Enable this option to load the JSON instructions from a 
file.
 |Filename|The filename for the file with JSON instructions.
 |Use variable substitution|Enables variables to be used in the Script.
-|JSON|The JSON instructions to execute.
-Multiple statements can be separated by comma.
+|JSON|The JSON instructions to execute: one JSON document, or several in a 
JSON array (`[ {...}, {...} ]`).
 |===
 
 == Examples
@@ -62,4 +61,21 @@ Multiple instructions
     {"create":"hop_collection"},
     {"drop": "hop_collection" }
 ]
-----
\ No newline at end of file
+----
+
+== Result
+
+What this action passes on to the next action. See 
xref:workflow/action-results.adoc[Action results] for how results travel 
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|Every instruction ran, with 0 errors. An instruction that returns 
documents, like `find`, is true too: the documents are not passed on.
+|False|The number of errors is 1. *MongoDB Connection* is empty or doesn't 
exist, the server can't be reached or refuses the login, *Use external file* is 
checked while *Filename* is empty or the file can't be read, the JSON is empty 
or not valid, or MongoDB refuses an instruction (for example an unknown 
command). The instructions of an array run one after the other: the ones before 
the failing instruction stay done, the ones after it are not run.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+NOTE: Several instructions must be in a JSON array. Instructions separated by 
commas without the brackets are not an error, but only the first one runs.
+
+NOTE: Write errors that MongoDB reports in its answer don't make the action 
false. For example an `insert` with a duplicate `_id` is true, although the 
duplicate document is not inserted.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snowflake-whm.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snowflake-whm.adoc
index 46ee3867cf..4fe89468fc 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snowflake-whm.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snowflake-whm.adoc
@@ -37,15 +37,15 @@ This action creates a new warehouse using the settings you 
provide.
 [options="header", width="90%", cols="1,3"]
 |===
 |Option|Description
-|Replace?|If the warehouse already exists, replace the existing warehouse with 
your new settings.
-|Fail if warehouse exists?| If the warehouse already exists the action will 
fail.  If not checked and Replace? is not checked the action will perform no 
action if the warehouse already exists.
-|Warehouse Size| (X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large) 
The size of the warehouse to create.
-|Warehouse Type|(Standard, Enterprise) The type of warehouse to create.  
Enterprise warehouses have more memory available than Standard warehouses.
+|Replace|If the warehouse already exists, replace the existing warehouse with 
your new settings.
+|Fail if warehouse exists| If the warehouse already exists the action will 
fail.  If not checked and Replace is not checked the action will perform no 
action if the warehouse already exists.
+|Warehouse size| (X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large) 
The size of the warehouse to create.
+|Warehouse type|(Standard, Enterprise) The type of warehouse to create.  
Enterprise warehouses have more memory available than Standard warehouses.
 |Max cluster size|The maximum cluster size for clustered warehouses.
 |Min cluster size|The minimum cluster size for clustered warehouses.
-|Auto suspend|The number of minutes of inactivity after which the warehouse 
will automatically suspend.
-|Auto resume?|Should the warehouse automatically resume when queries are run 
against it?
-|Initially suspended?|Should the warehouse be created in a suspended state.
+|Auto suspend (minutes)|The number of minutes of inactivity after which the 
warehouse will automatically suspend.
+|Auto resume|Should the warehouse automatically resume when queries are run 
against it?
+|Initially suspended|Should the warehouse be created in a suspended state.
 |Resource monitor|The resource monitor used for tracking Snowflake usage and 
billing.
 |Comment|A comment to be included about the warehouse.
 |===
@@ -57,7 +57,7 @@ This action removes a warehouse from Snowflake.
 [options="header", width="90%", cols="1,3"]
 |===
 |Option|Description
-|Fail if warehouse does not exist?|If the warehouse does not exist, the action 
will fail.
+|Fail if warehouse does not exist|If the warehouse does not exist, the action 
will fail.
 |===
 
 === Action: Resume warehouse
@@ -87,12 +87,27 @@ This action alters the warehouse, enabling users to 
re-size, change warehouse ty
 |===
 |Option|Description
 |Fail if warehouse does not exist?|If the warehouse does not exist, the action 
will fail.
-|Warehouse Size|(X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large) 
The size of the warehouse to create.
-|Warehouse Type|(Standard, Enterprise) The type of warehouse to create.  
Enterprise warehouses have more memory available than Standard warehouses.
+|Warehouse size|(X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large) 
The size of the warehouse to create.
+|Warehouse type|(Standard, Enterprise) The type of warehouse to create.  
Enterprise warehouses have more memory available than Standard warehouses.
 |Max cluster size|The maximum cluster size for clustered warehouses.
 |Min cluster size|The minimum cluster size for clustered warehouses.
-|Auto suspend|The number of minutes of inactivity after which the warehouse 
will automatically suspend.
-|Auto resume?|Should the warehouse automatically resume when queries are run 
against it?
+|Auto suspend (minutes)|The number of minutes of inactivity after which the 
warehouse will automatically suspend.
+|Auto resume|Should the warehouse automatically resume when queries are run 
against it?
 |Resource monitor|The resource monitor used for tracking Snowflake usage and 
billing.
 |Comment|A comment to be included about the warehouse.
 |===
+
+== Result
+
+What this action passes on to the next action. See 
xref:workflow/action-results.adoc[Action results] for how results travel 
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The statement ran, with 0 errors.
+|False|The action doesn't count errors: the number of errors stays 0. 
*Connection* is empty, no *Action* is selected, for *Create warehouse* *Max 
cluster size* is not a positive number or *Min cluster size* or *Auto suspend 
(minutes)* is negative or not a number, the connection doesn't exist or can't 
connect, or Snowflake refuses the statement, for example when the warehouse 
exists and *Fail if warehouse exists* is checked, or doesn't exist and *Fail if 
warehouse does not exist* is checked.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+NOTE: *Create warehouse* and *Alter warehouse* use *Warehouse name* as it is 
typed: variables in the name are not resolved, unlike for *Drop warehouse*, 
*Resume warehouse* and *Suspend warehouse*.

Reply via email to