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 e202c63553 Website updated to b04100c
e202c63553 is described below

commit e202c63553ff7232fa07bb0aa43b237ab0f2aa31
Author: jenkins <[email protected]>
AuthorDate: Mon Nov 2 18:25:33 2026 +0000

    Website updated to b04100c
---
 manual/next/metadata-types/ai-provider.html        | 54 +++++++++++++--
 .../pipeline/beam/developing-beam-transforms.html  | 74 ++++++++++++++++++---
 .../next/pipeline/transforms/avro-file-input.html  |  8 +++
 .../next/pipeline/transforms/avro-file-output.html |  8 +++
 manual/next/workflow/actions/as400command.html     | 42 +++++++++++-
 .../next/workflow/actions/databricks-job-wait.html | 60 +++++++++++++++--
 manual/next/workflow/actions/documentation.html    | 74 ++++++++++++++++++---
 manual/next/workflow/actions/mql.html              | 65 +++++++++++++++++-
 manual/next/workflow/actions/snowflake-whm.html    | 76 ++++++++++++++++++----
 9 files changed, 418 insertions(+), 43 deletions(-)

diff --git a/manual/next/metadata-types/ai-provider.html 
b/manual/next/metadata-types/ai-provider.html
index f9efde7af1..0d1cd5825b 100644
--- a/manual/next/metadata-types/ai-provider.html
+++ b/manual/next/metadata-types/ai-provider.html
@@ -2965,7 +2965,7 @@ Objects are managed in the Metadata perspective and 
stored as JSON under:</p>
 <p><code>metadata/ai-provider/</code></p>
 </div>
 <div class="paragraph">
-<p>Use <strong>Refresh models</strong> to load model ids from the provider 
(OpenAI-compatible <code>/models</code>, Anthropic and Mistral catalogs, Ollama 
<code>/api/tags</code>). Hugging Face has no list API; type a router model id. 
The combo stays editable so you can enter a name that is not in the list.</p>
+<p>Use <strong>Refresh models</strong> to load model ids from the provider 
(OpenAI-compatible <code>/models</code>, Anthropic and Mistral catalogs, Ollama 
<code>/api/tags</code>, or the GitHub Copilot CLI). Hugging Face has no list 
API; type a router model id. The combo stays editable so you can enter a name 
that is not in the list.</p>
 </div>
 <div class="paragraph">
 <p>Use the <strong>Test</strong> button in the editor to send a short 
health-check prompt.</p>
@@ -3057,11 +3057,57 @@ See <a 
href="../pipeline/transforms/languagemodelchat.html#ai-provider-precedenc
 <td class="tableblock halign-left valign-top"><p class="tableblock">Router 
model id (for example <code>meta-llama/Llama-3.3-70B-Instruct</code>), or a 
dedicated endpoint URL if Base URL is empty</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Yes 
(token)</p></td>
 </tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GitHub 
Copilot</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installed 
Copilot CLI</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">CLI 
default, or select a model from <strong>Refresh models</strong></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">No; uses 
the CLI&#8217;s logged-in account</p></td>
+</tr>
 </tbody>
 </table>
 <div class="paragraph">
-<p>OpenAI, Grok, Gemini and Custom share the OpenAI Chat Completions API.
-A GitHub Copilot-style OAuth provider is an extension point; it is not 
bundled.</p>
+<p>GitHub Copilot uses the official Java SDK to start the installed GitHub 
Copilot CLI. Install and
+sign in to the CLI as the same operating-system user that runs Hop. Hop looks 
for the CLI in this
+order: the <strong>Copilot CLI path</strong> field on the provider&#8217;s 
<strong>GitHub Copilot</strong> tab, the <code>COPILOT_CLI_PATH</code>
+environment variable, then <code>copilot</code> on the <code>PATH</code>.
+Other tools install a <code>copilot</code> command too, for example the AWS 
Copilot CLI. If the error says
+<code>unknown flag: --server</code>, Hop started one of those: enter the path 
of the GitHub Copilot CLI.</p>
+</div>
+<div class="paragraph">
+<p>Authentication remains with the CLI; Hop metadata stores no GitHub token. 
The session gets no
+tools, and Hop refuses any permission request from the CLI, so an answer 
cannot run commands or
+touch files. Every question counts against the Copilot plan of the signed-in 
account.</p>
+</div>
+<div class="paragraph">
+<p>The GitHub Copilot provider works with the AI Assistant only. Language 
Model Chat, Structured
+Extract, Extract Graph and Embed Text cannot use it.</p>
+</div>
+<div class="sect2">
+<h3 id="_github_copilot_on_a_server_in_a_container_or_in_hop_web"><a 
class="link" 
href="#_github_copilot_on_a_server_in_a_container_or_in_hop_web">GitHub Copilot 
on a server, in a container or in Hop Web</a></h3>
+<div class="paragraph">
+<p>On a machine without a browser, the default sign-in fails: the browser 
cannot reach the CLI&#8217;s
+callback. Sign in with a device code instead, as the user that runs Hop:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<div class="code-lang" data-pagefind-ignore>bash</div><pre class="highlightjs 
highlight is-highlighted"><code class="language-bash hljs" 
data-lang="bash">copilot login --device-code</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Open the URL the CLI prints, enter the code and approve. Without a system 
credential store the
+CLI asks to keep the token in a plain-text file under <code>~/.copilot</code>: 
answer yes, and keep that
+folder on a volume in a container.</p>
+</div>
+<div class="paragraph">
+<p>Instead of signing in, you can give the CLI a fine-grained personal access 
token with the
+<strong>Copilot Requests</strong> permission in 
<code>COPILOT_GITHUB_TOKEN</code>, <code>GH_TOKEN</code> or 
<code>GITHUB_TOKEN</code> (checked in
+that order). Classic tokens (<code>ghp_</code>) are not accepted.</p>
+</div>
+<div class="paragraph">
+<p>In Hop Web the CLI runs on the server, as the server&#8217;s 
operating-system user. Everyone who uses
+a GitHub Copilot provider in that Hop Web uses the account the server signed 
in with, and its
+Copilot plan.</p>
+</div>
 </div>
 </div>
 </div>
@@ -3144,7 +3190,7 @@ Applies to Ollama only for now; other provider types 
ignore it.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Off by 
default.
 When checked, the AI Assistant asks the provider to hold the model to a JSON 
schema: the answer text plus a list of proposals with a known type, a risk 
level and their parameters.
 The proposals then cannot come back broken, which helps small models most.
-Works with Ollama, OpenAI, Anthropic and Mistral. Other types (Gemini, Grok, 
custom OpenAI-compatible servers, Hugging Face) answer as usual.
+Works with Ollama, OpenAI, Anthropic and Mistral. Other types (Gemini, Grok, 
custom OpenAI-compatible servers, Hugging Face and GitHub Copilot) answer as 
usual.
 When the provider refuses the schema, the question is asked again without it 
and the log says so.
 Some models write shorter answers this way: compare with and without it on the 
models you use, for example with the evaluation set described in <a 
href="../technology/ai/index.html" class="xref page">AI technology</a>.</p></td>
 </tr>
diff --git a/manual/next/pipeline/beam/developing-beam-transforms.html 
b/manual/next/pipeline/beam/developing-beam-transforms.html
index 55d17c3b80..5946e052e9 100644
--- a/manual/next/pipeline/beam/developing-beam-transforms.html
+++ b/manual/next/pipeline/beam/developing-beam-transforms.html
@@ -2987,19 +2987,35 @@
 <div class="olist arabic">
 <ol class="arabic">
 <li>
-<p>An entry in the converter&#8217;s handler map, keyed by the transform 
plugin id. This is an explicitly registered handler class.</p>
+<p>An entry in the converter&#8217;s handler map, keyed by the transform 
plugin id. <code>addDefaultTransformHandlers()</code> installs these. The same 
ids are listed in <code>EXPLICIT_HANDLER_PLUGIN_IDS</code>, which is what 
<code>BeamPipelineEngine.supports()</code> reads at design time. Add Sequence 
is this form: <code>BeamAddSequenceTransformHandler</code> is registered for 
the <code>Sequence</code> plugin id, and the meta class itself does not 
implement the handler interface.</p>
 </li>
 <li>
-<p>The metadata object itself, when it implements 
<code>IBeamPipelineTransformHandler</code>. MQTT, Debezium, Elasticsearch, 
Splunk output, and Snowflake input and output use this form.</p>
+<p>The metadata object itself, when it implements 
<code>IBeamPipelineTransformHandler</code>. BigQuery input, MQTT, Debezium, 
Elasticsearch, Splunk output, and Snowflake input and output use this form. 
<code>supports()</code> reports the transform supported because the meta class 
implements the interface.</p>
 </li>
 <li>
-<p>For anything else, <code>handleGenericTransform()</code> tries to run the 
ordinary Hop transform inside a Beam <code>DoFn</code>.</p>
+<p>For anything else, <code>handleGenericTransform()</code> tries to run the 
ordinary Hop transform inside a Beam <code>DoFn</code> 
(<code>BeamGenericTransformHandler</code>). <code>supports()</code> reports 
that case as unknown.</p>
 </li>
 </ol>
 </div>
 <div class="paragraph">
 <p>The generic fallback is not a compatibility promise. It gives every worker 
its own copy of the transform. A transform that opens one file, one sequence, 
or one database session will do that once per worker. Sources that read a 
filename from an incoming field also fail there, because the generic path has 
no real input row.</p>
 </div>
+<div class="paragraph">
+<p>To add a handler, pick the first form that fits:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Implement <code>IBeamPipelineTransformHandler</code> on the meta class when 
the transform exists only for Beam, and build the <code>PTransform</code> in 
<code>handleTransform</code>. See <code>BeamBQInputMeta</code>.</p>
+</li>
+<li>
+<p>Implement <code>IBeamPipelineTransformHandler</code> on a standalone class 
in the Beam engine, register it in <code>addDefaultTransformHandlers()</code>, 
and add the plugin id to <code>EXPLICIT_HANDLER_PLUGIN_IDS</code>. See 
<code>BeamAddSequenceTransformHandler</code>. Keep those two lists the same. 
This is the form for a transform whose meta class lives in another plugin.</p>
+</li>
+<li>
+<p>Do nothing, and accept the generic <code>DoFn</code>, until a file, a 
counter, or a connection shows that each worker is doing the work on its 
own.</p>
+</li>
+</ol>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -3014,21 +3030,24 @@
 </div>
 </div>
 <div class="sect1">
-<h2 id="_metadata_dialog_and_worker_code"><a class="link" 
href="#_metadata_dialog_and_worker_code">Metadata, dialog, and worker 
code</a></h2>
+<h2 id="_metadata_dialog_data_and_worker_code"><a class="link" 
href="#_metadata_dialog_data_and_worker_code">Metadata, dialog, data, and 
worker code</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Keep the four roles separate:</p>
+<p>A Hop transform is four classes. Beam uses the same four. Only the meta 
class and the worker function participate in the Beam graph.</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
-<p>The <code>*Meta</code> class holds <code>@HopMetadataProperty</code> fields 
and, for a self-handling transform, implements 
<code>IBeamPipelineTransformHandler</code>. User-visible fields also use 
<code>@GuiWidgetElement</code> inside a group, so the dialog is a 
<code>GuiCompositeWidgets</code> container rather than a hand-built form.</p>
+<p>The <code>*Meta</code> class extends <code>BaseTransformMeta&lt;Transform, 
TransformData&gt;</code>. It holds <code>@HopMetadataProperty</code> fields 
and, for a self-handling transform, implements 
<code>IBeamPipelineTransformHandler</code>. User-visible fields also use 
<code>@GuiWidgetElement</code> inside a group, so the dialog is a 
<code>GuiCompositeWidgets</code> container rather than a hand-built form.</p>
 </li>
 <li>
 <p>The dialog reads and writes that metadata. On OK it calls 
<code>getWidgetsContents</code>. It does not copy fields by hand.</p>
 </li>
 <li>
-<p>The runtime <code>*Transform</code> class extends 
<code>BaseTransform</code> and refuses <code>processRow()</code> outside a Beam 
pipeline. Beam execution does not call it.</p>
+<p>The <code>*Data</code> class is per-copy state for the local engine: an 
open file, a counter, a database connection. Beam does not call 
<code>init()</code> on that object and then reuse it across elements. A worker 
that needs state keeps it on the <code>DoFn</code>, and it must assume a new 
copy per worker and per bundle.</p>
+</li>
+<li>
+<p>The runtime <code>*Transform</code> class extends 
<code>BaseTransform</code> and refuses <code>processRow()</code> outside a Beam 
pipeline. Beam execution does not call it. The local engine still does.</p>
 </li>
 <li>
 <p>Worker functions, such as a <code>DoFn</code> or a Snowflake mapper, call 
<code>BeamHop.init()</code> before they touch Hop metadata. Row metadata 
travels as XML from <code>IRowMeta.getMetaXml()</code>, including storage type 
and string encoding. Do not rebuild a row meta from a type name alone.</p>
@@ -3044,7 +3063,46 @@
 <h2 id="_metrics"><a class="link" href="#_metrics">Metrics</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><code>BeamPipelineEngine</code> copies Beam counters onto the Hop transform 
by counter name. <code>READ</code> becomes lines read, <code>WRITTEN</code> 
becomes lines written, <code>INPUT</code> becomes lines input, and 
<code>OUTPUT</code> becomes lines output. Increment <code>WRITTEN</code> only 
after a confirmed write. The current IO transforms increment <code>READ</code> 
and <code>OUTPUT</code> when a row is converted and handed to Beam. That is not 
an acknowledgement from the remot [...]
+<p>Create counters with <code>Metrics.counter(namespace, 
transformName)</code>. The namespace is a <code>Pipeline</code> constant and 
the counter name is the transform name. <code>BeamPipelineEngine</code> copies 
a counter onto that transform when the namespace matches, ignoring case:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>Pipeline.METRIC_NAME_READ</code> (<code>read</code>) becomes lines 
read.</p>
+</li>
+<li>
+<p><code>Pipeline.METRIC_NAME_WRITTEN</code> (<code>written</code>) becomes 
lines written.</p>
+</li>
+<li>
+<p><code>Pipeline.METRIC_NAME_INPUT</code> (<code>input</code>) becomes lines 
input.</p>
+</li>
+<li>
+<p><code>Pipeline.METRIC_NAME_OUTPUT</code> (<code>output</code>) becomes 
lines output.</p>
+</li>
+<li>
+<p><code>Pipeline.METRIC_NAME_INIT</code> (<code>init</code>) is stored as the 
init metric.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p><code>Pipeline.METRIC_NAME_ERROR</code> is incremented by the current IO 
functions. The engine copy loop does not map that namespace onto the transform 
error count. Increment <code>METRIC_NAME_WRITTEN</code> only after a confirmed 
write. The current IO transforms increment <code>METRIC_NAME_READ</code> and 
<code>METRIC_NAME_OUTPUT</code> when a row is converted and handed to Beam. 
That is not an acknowledgement from the remote system, and lines written stays 
empty.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_transforms_beam_refuses"><a class="link" 
href="#_transforms_beam_refuses">Transforms Beam refuses</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p><code>HopPipelineMetaToBeamPipelineConverter</code> keeps two refusal 
lists, and <code>BeamPipelineEngine.supports()</code> reads both before it 
looks for a handler.</p>
+</div>
+<div class="paragraph">
+<p><code>HARD_BANNED_META_TYPES</code> maps a meta class to the sentence Hop 
shows the user. Group By, Unique Rows, Sort Rows, Unique Rows By Hashset, and 
Join Rows are on it. The class is loaded when the converter class is 
initialized, so the meta class has to be on the Beam plugin class loader. 
<code>dependencies.xml</code> is what puts those plugin folders on that 
loader.</p>
+</div>
+<div class="paragraph">
+<p><code>HARD_BANNED_PLUGIN_IDS</code> is the same kind of refusal for a 
transform that is not on that loader. Mask fields is banned by plugin id for 
that reason. A class literal for its meta class would fail to initialize the 
converter.</p>
+</div>
+<div class="paragraph">
+<p>A banned transform does not fall through to the generic <code>DoFn</code>. 
<code>validateTransformBeamUsage()</code> throws that sentence while the graph 
is built, and <code>BeamPipelineEngine.supports()</code> returns the same 
sentence at design time.</p>
 </div>
 </div>
 </div>
diff --git a/manual/next/pipeline/transforms/avro-file-input.html 
b/manual/next/pipeline/transforms/avro-file-input.html
index c63fd5505e..2197e41d6b 100644
--- a/manual/next/pipeline/transforms/avro-file-input.html
+++ b/manual/next/pipeline/transforms/avro-file-input.html
@@ -3093,6 +3093,14 @@ Note: This name has to be unique in a single 
pipeline.</p></td>
 </tbody>
 </table>
 </div>
+</div>
+<div class="sect1">
+<h2 id="_beam"><a class="link" href="#_beam">Beam</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>On a Beam runner each file is read by one worker, and the records are 
appended to the row that named the file. A positive row limit is the most 
records that worker emits across the files it reads. A null or empty filename 
is skipped. The native Spark engine stays excluded.</p>
+</div>
+</div>
 </div>
     </article>
 <nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/pipeline/transforms/avro-file-output.html 
b/manual/next/pipeline/transforms/avro-file-output.html
index 04b835ab41..c690f94061 100644
--- a/manual/next/pipeline/transforms/avro-file-output.html
+++ b/manual/next/pipeline/transforms/avro-file-output.html
@@ -3185,6 +3185,14 @@ AVRO_TYPE_STRING = 6<br>
 AVRO_TYPE_ENUM = 7</p>
 </div>
 </div>
+</div>
+<div class="sect1">
+<h2 id="_beam"><a class="link" href="#_beam">Beam</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Binary file output writes one Avro file with <code>AvroIO</code>. The 
filename, including the date and time, is resolved when the pipeline is 
submitted. A transform copy number or a partition number in the filename is 
refused. Nested Avro paths and enum fields are refused. Binary-field and 
JSON-field output still run as an ordinary Beam transform and add a column to 
the row.</p>
+</div>
+</div>
 </div>
     </article>
 <nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/as400command.html 
b/manual/next/workflow/actions/as400command.html
index ba4f2643cd..4d898ec3ef 100644
--- a/manual/next/workflow/actions/as400command.html
+++ b/manual/next/workflow/actions/as400command.html
@@ -2995,11 +2995,11 @@
 <td class="tableblock halign-left valign-top"><p class="tableblock">The 
password associated the AS/400 server account.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Proxy 
host</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Host name 
(Proxy)</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Proxy 
server host name or IP address.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Proxy 
port</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Port 
(Proxy)</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Proxy 
server port number.</p></td>
 </tr>
 <tr>
@@ -3021,6 +3021,44 @@ This plugin tries to load the as400 library from the 
as400 database plugin.
 </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 
command ran successfully, with 0 errors.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p 
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number 
of errors is 1. The server can&#8217;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.</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/databricks-job-wait.html 
b/manual/next/workflow/actions/databricks-job-wait.html
index c88ea13c69..8a329e2621 100644
--- a/manual/next/workflow/actions/databricks-job-wait.html
+++ b/manual/next/workflow/actions/databricks-job-wait.html
@@ -3023,16 +3023,16 @@
 <td class="tableblock halign-left valign-top"><p class="tableblock">Numeric 
run id; default <code>${DatabricksRunId}</code></p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout 
(seconds)</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum 
wait; <code>0</code> = no timeout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout 
(seconds, 0=none)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum 
wait; <code>0</code> = no timeout. A value that is not a number is replaced by 
3600.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Poll 
interval (seconds)</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Delay 
between status checks (default 15)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Delay 
between status checks (default 15, at least 1)</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Cancel run 
if workflow is stopped</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">If 
checked, calls <code>jobs/runs/cancel</code> when the parent workflow 
stops</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Cancel 
Databricks run if workflow is stopped</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">If 
checked, calls <code>jobs/runs/cancel</code> when the parent workflow stops, 
and also when the timeout is reached</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Result 
variables</p></td>
@@ -3059,6 +3059,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 run 
ended with life cycle state <code>TERMINATED</code> and result state 
<code>SUCCESS</code>, with 0 errors.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p 
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number 
of errors is 1. <strong>Databricks connection</strong> is empty or 
doesn&#8217;t exist, <strong>Run ID</strong> is empty or not a number, a call 
to the Jobs API fails, the run ends with another result state (for example 
<code>FAILED</code> or <code>CANCELED</code>) or with life cycle state 
<code>SKIPPED</code> or <code>INTERNAL_ERROR</code>, the timeout is reached, or 
the workflow is stopped while the action w [...]
+</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">
+After every status check the action sets the result variables for the Job ID, 
the Run ID, the status (the result state, like <code>SUCCESS</code> or 
<code>FAILED</code>, once the run is <code>TERMINATED</code>, 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  [...]
+</td>
+</tr>
+</table>
+</div>
+</div>
 </div>
     </article>
 <nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/documentation.html 
b/manual/next/workflow/actions/documentation.html
index 7ae1369850..a9f5e21433 100644
--- a/manual/next/workflow/actions/documentation.html
+++ b/manual/next/workflow/actions/documentation.html
@@ -2981,13 +2981,13 @@
 <div class="ulist">
 <ul>
 <li>
-<p>The target folder in which you want your project documentation to end up 
in.</p>
+<p>The target folder: the folder in which you want your project documentation 
to end up in.</p>
 </li>
 <li>
-<p>Include notes?</p>
+<p>Include notes text?</p>
 </li>
 <li>
-<p>Include parameters?</p>
+<p>List parameters?</p>
 </li>
 <li>
 <p>Include metadata?</p>
@@ -2996,7 +2996,7 @@
 <p>Generate HTML?</p>
 </li>
 <li>
-<p>Remove MarkDown after HTML is generated?</p>
+<p>Remove MarkDown files?: only when <strong>Generate HTML?</strong> is 
checked, removes the MarkDown files after the HTML is generated.</p>
 </li>
 </ul>
 </div>
@@ -3006,14 +3006,70 @@
 <h2 id="_generating_html_from_markdown"><a class="link" 
href="#_generating_html_from_markdown">Generating HTML from MarkDown</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>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:</p>
+<p>With <strong>Generate HTML?</strong> the action writes an HTML file next to 
each MarkDown file, and the HTML index links to the HTML files. With 
<strong>Remove MarkDown files?</strong> the MarkDown files are removed and the 
HTML files, the images and the styles stay.</p>
 </div>
-<div class="listingblock">
-<div class="content">
-<div class="code-lang" data-pagefind-ignore>bash</div><pre class="highlightjs 
highlight is-highlighted"><code class="language-bash hljs" 
data-lang="bash"><span class="hljs-keyword">for</span> i <span 
class="hljs-keyword">in</span> $(find . -name <span 
class="hljs-string">&#x27;*.md&#x27;</span>) ; <span 
class="hljs-keyword">do</span> <span class="hljs-built_in">echo</span> <span 
class="hljs-string">&quot;<span class="hljs-variable">$i</span>&quot;</span> 
&amp;&amp; pandoc -s <span class= [...]
 </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 
documentation of the project folder was written to the target folder. The 
action doesn&#8217;t set its own result: it passes on the result of the 
previous action, 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. The target folder is empty, is a file, or can&#8217;t be 
written, or a file of the project can&#8217;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.</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 documentation files are not added.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Result 
rows</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passed on 
unchanged.</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 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.
+</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">
+Files that are already in the target folder stay.
+</td>
+</tr>
+</table>
+</div>
 </div>
 </div>
     </article>
diff --git a/manual/next/workflow/actions/mql.html 
b/manual/next/workflow/actions/mql.html
index bc7accebfc..695fd23fa0 100644
--- a/manual/next/workflow/actions/mql.html
+++ b/manual/next/workflow/actions/mql.html
@@ -3024,8 +3024,7 @@
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p 
class="tableblock">JSON</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The JSON 
instructions to execute.
-Multiple statements can be separated by comma.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The JSON 
instructions to execute: one JSON document, or several in a JSON array (<code>[ 
{&#8230;&#8203;}, {&#8230;&#8203;} ]</code>).</p></td>
 </tr>
 </tbody>
 </table>
@@ -3054,6 +3053,68 @@ Multiple statements can be separated by comma.</p></td>
 </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">Every 
instruction ran, with 0 errors. An instruction that returns documents, like 
<code>find</code>, is true too: the documents 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. <strong>MongoDB Connection</strong> is empty or doesn&#8217;t 
exist, the server can&#8217;t be reached or refuses the login, <strong>Use 
external file</strong> is checked while <strong>Filename</strong> is empty or 
the file can&#8217;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 [...]
+</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">
+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.
+</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">
+Write errors that MongoDB reports in its answer don&#8217;t make the action 
false. For example an <code>insert</code> with a duplicate <code>_id</code> is 
true, although the duplicate document is not inserted.
+</td>
+</tr>
+</table>
+</div>
+</div>
 </div>
     </article>
 <nav class="pagination" data-pagefind-ignore aria-label="Page">
diff --git a/manual/next/workflow/actions/snowflake-whm.html 
b/manual/next/workflow/actions/snowflake-whm.html
index d869eff1f7..bc0a59d37c 100644
--- a/manual/next/workflow/actions/snowflake-whm.html
+++ b/manual/next/workflow/actions/snowflake-whm.html
@@ -2999,19 +2999,19 @@
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p 
class="tableblock">Replace?</p></td>
+<td class="tableblock halign-left valign-top"><p 
class="tableblock">Replace</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">If the 
warehouse already exists, replace the existing warehouse with your new 
settings.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Fail if 
warehouse exists?</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Fail if 
warehouse exists</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">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.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
Size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
size</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">(X-Small, 
Small, Medium, Large, X-Large, 2X-Large, 3X-Large) The size of the warehouse to 
create.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
Type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
type</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">(Standard, 
Enterprise) The type of warehouse to create.  Enterprise warehouses have more 
memory available than Standard warehouses.</p></td>
 </tr>
 <tr>
@@ -3023,15 +3023,15 @@
 <td class="tableblock halign-left valign-top"><p class="tableblock">The 
minimum cluster size for clustered warehouses.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
suspend</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
suspend (minutes)</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The number 
of minutes of inactivity after which the warehouse will automatically 
suspend.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
resume?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
resume</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Should the 
warehouse automatically resume when queries are run against it?</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Initially 
suspended?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Initially 
suspended</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Should the 
warehouse be created in a suspended state.</p></td>
 </tr>
 <tr>
@@ -3063,7 +3063,7 @@
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Fail if 
warehouse does not exist?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Fail if 
warehouse does not exist</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">If the 
warehouse does not exist, the action will fail.</p></td>
 </tr>
 </tbody>
@@ -3139,11 +3139,11 @@
 <td class="tableblock halign-left valign-top"><p class="tableblock">If the 
warehouse does not exist, the action will fail.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
Size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
size</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">(X-Small, 
Small, Medium, Large, X-Large, 2X-Large, 3X-Large) The size of the warehouse to 
create.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
Type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Warehouse 
type</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">(Standard, 
Enterprise) The type of warehouse to create.  Enterprise warehouses have more 
memory available than Standard warehouses.</p></td>
 </tr>
 <tr>
@@ -3155,11 +3155,11 @@
 <td class="tableblock halign-left valign-top"><p class="tableblock">The 
minimum cluster size for clustered warehouses.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
suspend</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
suspend (minutes)</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The number 
of minutes of inactivity after which the warehouse will automatically 
suspend.</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
resume?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto 
resume</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Should the 
warehouse automatically resume when queries are run against it?</p></td>
 </tr>
 <tr>
@@ -3174,6 +3174,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 
statement ran, with 0 errors.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p 
class="tableblock">False</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The action 
doesn&#8217;t count errors: the number of errors stays 0. 
<strong>Connection</strong> is empty, no <strong>Action</strong> is selected, 
for <strong>Create warehouse</strong> <strong>Max cluster size</strong> is not 
a positive number or <strong>Min cluster size</strong> or <strong>Auto suspend 
(minutes)</strong> is negative or not a number, the connection doesn&#8217;t 
exist or can&#8217;t connect, or Snowflake [...]
+</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">
+<strong>Create warehouse</strong> and <strong>Alter warehouse</strong> use 
<strong>Warehouse name</strong> as it is typed: variables in the name are not 
resolved, unlike for <strong>Drop warehouse</strong>, <strong>Resume 
warehouse</strong> and <strong>Suspend warehouse</strong>.
+</td>
+</tr>
+</table>
+</div>
+</div>
 </div>
     </article>
 <nav class="pagination" data-pagefind-ignore aria-label="Page">

Reply via email to