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 2526e320e6 Website updated to b04100c
2526e320e6 is described below
commit 2526e320e680ba66745295d5c0613074146413ca
Author: jenkins <[email protected]>
AuthorDate: Fri Nov 6 09:48:49 2026 +0000
Website updated to b04100c
---
dev-manual/next/sdk/plugins/transforms.html | 50 +++++++++++++++++++++++
manual/next/workflow/actions/pgpdecryptfiles.html | 16 ++++----
manual/next/workflow/actions/pgpencryptfiles.html | 24 ++++++-----
3 files changed, 72 insertions(+), 18 deletions(-)
diff --git a/dev-manual/next/sdk/plugins/transforms.html
b/dev-manual/next/sdk/plugins/transforms.html
index 44c423e378..90700cccb4 100644
--- a/dev-manual/next/sdk/plugins/transforms.html
+++ b/dev-manual/next/sdk/plugins/transforms.html
@@ -850,6 +850,56 @@ The <code>open()</code> recipe is <a
href="../../annotation-derived-widgets.html
</div>
</div>
<div class="sect1">
+<h2 id="_parsing_text_into_a_field"><a class="link"
href="#_parsing_text_into_a_field">Parsing text into a field</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>A transform that turns text into a typed value parses it with String
metadata built from the target field.
+Examples are a value read from a file, a constant, a default value or a lookup
key.
+Build that metadata with <code>ValueMetaFactory.createParseMeta</code> for one
field or <code>ValueMetaFactory.createParseRowMeta</code> for a whole row.
+Build it once, for example on the first row, and keep it in the data class.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<div class="code-lang" data-pagefind-ignore>java</div><pre class="highlightjs
highlight is-highlighted"><code class="language-java hljs"
data-lang="java"><span class="hljs-keyword">if</span> (first) {
+ first = <span class="hljs-literal">false</span>;
+ data.outputRowMeta = getInputRowMeta().clone();
+ meta.getFields(data.outputRowMeta, getTransformName(), <span
class="hljs-literal">null</span>, <span class="hljs-literal">null</span>, <span
class="hljs-built_in">this</span>, metadataProvider);
+ data.convertRowMeta =
ValueMetaFactory.createParseRowMeta(data.outputRowMeta);
+}
+
+<span class="hljs-keyword">for</span> (<span class="hljs-type">int</span>
<span class="hljs-variable">i</span> <span class="hljs-operator">=</span> <span
class="hljs-number">0</span>; i < data.outputRowMeta.size(); i++) {
+ <span class="hljs-type">IValueMeta</span> <span
class="hljs-variable">valueMeta</span> <span class="hljs-operator">=</span>
data.outputRowMeta.getValueMeta(i);
+ <span class="hljs-type">IValueMeta</span> <span
class="hljs-variable">convertMeta</span> <span class="hljs-operator">=</span>
data.convertRowMeta.getValueMeta(i);
+ outputRow[i] = valueMeta.convertDataFromString(texts[i], convertMeta, <span
class="hljs-literal">null</span>, <span class="hljs-literal">null</span>, <span
class="hljs-number">0</span>);
+}</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The parse metadata keeps everything that decides how text is parsed: the
conversion mask, the decimal, grouping and currency symbols, the trim type, the
string encoding, the date format locale, time zone and leniency.
+It always has normal storage, because the text to parse is a plain
<code>String</code>, also when the target field is lazy (binary string).
+Pass it as the source metadata, to <code>convertDataFromString(text,
parseMeta, nullIf, ifNull, trimType)</code> or <code>convertData(parseMeta,
text)</code>.</p>
+</div>
+<div class="paragraph">
+<p>Don’t build the parse metadata in any of these ways:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>rowMeta.cloneToType(IValueMeta.TYPE_STRING)</code> or
<code>ValueMetaFactory.cloneValueMeta(valueMeta,
IValueMeta.TYPE_STRING)</code>: drops the currency symbol and keeps the storage
type of a lazy field.
+With a <code>ยค</code> mask the field then can’t read back the text it
writes, and a lazy field fails with a <code>ClassCastException</code>.
+<code>IRowMeta.cloneToType</code> is deprecated for this reason.</p>
+</li>
+<li>
+<p><code>new ValueMetaString(name)</code>: has none of the target’s mask
or symbols, so every value is parsed with the defaults of the machine.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p><code>plugins/transforms/datagrid</code> (<code>DataGrid</code>) is a short
example of this pattern.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_concrete_codebase_examples"><a class="link"
href="#_concrete_codebase_examples">Concrete Codebase Examples</a></h2>
<div class="sectionbody">
<div class="ulist">
diff --git a/manual/next/workflow/actions/pgpdecryptfiles.html
b/manual/next/workflow/actions/pgpdecryptfiles.html
index f34c61fe48..7b72807f1a 100644
--- a/manual/next/workflow/actions/pgpdecryptfiles.html
+++ b/manual/next/workflow/actions/pgpdecryptfiles.html
@@ -3082,7 +3082,7 @@
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">If
destination file exists</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
-<p>What to do when the destination file already exists. See the WARNING under
<a href="#_result">Result</a>.</p>
+<p>What to do when the destination file already exists. <strong>Delete source
file</strong> deletes the source and leaves the destination unchanged.
<strong>Move source file to folder</strong> leaves the destination unchanged
and moves the source into <strong>Destination folder</strong>. <strong>Do
nothing</strong> leaves an existing file unchanged.</p>
</div>
<div class="ulist">
<ul>
@@ -3254,11 +3254,11 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Errors</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files and entries that failed. Inside a folder, when files are left after
the one that breaks the success condition, that failure counts as two
errors.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files and entries that failed. Inside a folder, the action stops once the
success condition is broken, and that failure counts as one error. A
<strong>GPG location</strong> that is empty or not found counts as 1 error,
before any file: the action is false with <strong>Success when all works
fine</strong> and <strong>Success when at least x files decrypted</strong>, and
true with <strong>Success when number [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add files to result files name</strong>, a decrypted file that
didn’t exist yet in the destination is added unless <strong>If
destination file exists</strong> is <strong>Do nothing</strong> (the default)
or <strong>Fail</strong>: with the default, no file is added. When the
destination file already exists, a file is added only with <strong>Overwrite
destination file</strong> or <strong>Create file with [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add files to result files name</strong>, the decrypted file is added.
That includes a file that did not exist yet, whatever <strong>If destination
file exists</strong> says, because that option only applies when the
destination already exists. When it does, the written file is added for
<strong>Overwrite destination file</strong> and <strong>Create file with unique
name</strong> (the new file). <strong>Move [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
@@ -3266,7 +3266,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
written</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files decrypted. A file left in place by <strong>Do nothing</strong>,
deleted or moved is not counted. When the check of <strong>Destination
folder</strong> (Move to folder) fails, or the action stops on the success
condition between two entries of the list, the value of the previous action is
passed on.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files decrypted. <strong>Delete source file</strong> counts the deleted
source and does not write the destination. A source moved to a new name is not
counted; overwriting or giving a unique name to a file that already exists in
<strong>Destination folder</strong> counts that file. A file left in place by
<strong>Do nothing</strong>, and a file rejected by <strong>Fail</strong> or by
<strong>If file exists [...]
</tr>
</tbody>
</table>
@@ -3289,19 +3289,19 @@ The decrypted file keeps the name of the source file:
<code>a.txt.gpg</code> bec
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-A <strong>GPG location</strong> that is empty or not found doesn’t make
the action false: the workflow stops with an error, and no hop from the action
is followed.
+A <strong>GPG location</strong> that is empty or not found counts as 1 error,
before any file. The action is false with <strong>Success when all works
fine</strong> and <strong>Success when at least x files decrypted</strong>, and
true with <strong>Success when number of errors lesser than</strong> (the
default limit is 10). When the action is false, the error hop is followed. The
workflow itself keeps running.
</td>
</tr>
</table>
</div>
-<div class="admonitionblock warning">
+<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
-<i class="fa icon-warning" title="Warning"></i>
+<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-<strong>If destination file exists</strong> doesn’t always do what its
name says. <strong>Delete source file</strong> deletes the existing destination
file, not the source, and decrypts nothing. <strong>Move source file to
folder</strong> moves the source file to <strong>Destination folder</strong>
without decrypting it.
+<strong>Delete source file</strong> deletes the source and leaves the existing
destination unchanged. <strong>Move source file to folder</strong> leaves the
existing destination unchanged and moves the source into <strong>Destination
folder</strong>.
</td>
</tr>
</table>
diff --git a/manual/next/workflow/actions/pgpencryptfiles.html
b/manual/next/workflow/actions/pgpencryptfiles.html
index 6f3d3b8985..b92d9677b6 100644
--- a/manual/next/workflow/actions/pgpencryptfiles.html
+++ b/manual/next/workflow/actions/pgpencryptfiles.html
@@ -3009,7 +3009,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Copy
previous results to args</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Take the
rows below from the result of the previous action instead of from the grid. The
fields are read by position: action, file/folder source, wildcard, user ID,
file/folder destination, and optionally signing key as a sixth field.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Take the
rows below from the result of the previous action instead of from the grid. The
fields are read by position: action, file/folder source, wildcard, user ID,
file/folder destination, and optionally signing key as a sixth field and
passphrase as a seventh.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Action</p></td>
@@ -3036,6 +3036,10 @@
<td class="tableblock halign-left valign-top"><p class="tableblock">User ID of
the key to sign with, passed to GnuPG as <code>-u</code>. Used by Sign and Sign
and Encrypt; leave it empty to sign with the default key from the GnuPG
configuration.</p></td>
</tr>
<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Passphrase</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Passphrase
of the signing key. Sent to GnuPG on standard input, never on the command line.
Leave it empty when the key has no passphrase. Ignored by Encrypt.</p></td>
+</tr>
+<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Files/Folders</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The files
to encrypt.</p></td>
</tr>
@@ -3094,7 +3098,7 @@
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">If
destination file exists</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
-<p>What to do when the destination file already exists. See the WARNING under
<a href="#_result">Result</a>.</p>
+<p>What to do when the destination file already exists. <strong>Delete source
file</strong> deletes the source and leaves the destination unchanged.
<strong>Move source file to folder</strong> leaves the destination unchanged
and moves the source into <strong>Destination folder</strong>. <strong>Create
file with unique name</strong> writes a new file and leaves the existing one in
place. <strong>Do nothing</strong> leaves an existing file unchanged.</p>
</div>
<div class="ulist">
<ul>
@@ -3262,15 +3266,15 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">False</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The
success condition is not met. A file or an entry of the list fails, and counts
as an error, when its source doesn’t exist, the destination folder
doesn’t exist and <strong>Create destination folder</strong> is
unchecked, GnuPG fails (an unknown or empty <strong>User ID</strong>, a signing
key that needs a passphrase), the destination file exists and <strong>If
destination file exists</strong> is <strong>F [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">The
success condition is not met. A file or an entry of the list fails, and counts
as an error, when its source doesn’t exist, the destination folder
doesn’t exist and <strong>Create destination folder</strong> is
unchecked, GnuPG fails (an unknown or empty <strong>User ID</strong>, a missing
or wrong passphrase for a signing key that needs one), the destination file
exists and <strong>If destination file exi [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p
class="tableblock">Errors</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files and entries that failed. Inside a folder, when files are left after
the one that breaks the success condition, that failure counts as two errors. A
<strong>GPG location</strong> that is empty or not found counts as 1 error,
before any file: the action is false with <strong>Success when all works
fine</strong> and <strong>Success when at least x files decrypted</strong>, and
true with <strong>Success w [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files and entries that failed. Inside a folder, the action stops once the
success condition is broken, and that failure counts as one error. A
<strong>GPG location</strong> that is empty or not found counts as 1 error,
before any file: the action is false with <strong>Success when all works
fine</strong> and <strong>Success when at least x files decrypted</strong>, and
true with <strong>Success when number [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result
files</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add files to result files name</strong>, an encrypted file that
didn’t exist yet in the destination is added unless <strong>If
destination file exists</strong> is <strong>Do nothing</strong> (the default)
or <strong>Fail</strong>: with the default, no file is added. When the
destination file already exists, a file is added only with <strong>Overwrite
destination file</strong> or <strong>Create file wit [...]
+<td class="tableblock halign-left valign-top"><p class="tableblock">With
<strong>Add files to result files name</strong>, the encrypted or signed file
is added. That includes a file that did not exist yet, whatever <strong>If
destination file exists</strong> says, because that option only applies when
the destination already exists. When it does, the written file is added for
<strong>Overwrite destination file</strong> and <strong>Create file with unique
name</strong> (the new file). <st [...]
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result
rows</p></td>
@@ -3278,7 +3282,7 @@
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Lines
written</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files encrypted or signed. A file left in place by <strong>Do
nothing</strong>, deleted or moved is not counted. When the check of
<strong>Destination folder</strong> (Move to folder) fails, or the action stops
on the success condition between two entries of the list, the value of the
previous action is passed on.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The number
of files encrypted or signed. <strong>Delete source file</strong> counts the
deleted source and does not write the destination. A source moved to a new name
is not counted; overwriting or giving a unique name to a file that already
exists in <strong>Destination folder</strong> counts that file. A file left in
place by <strong>Do nothing</strong>, and a file rejected by
<strong>Fail</strong> or by <strong>If fi [...]
</tr>
</tbody>
</table>
@@ -3294,14 +3298,14 @@ The encrypted or signed file keeps the name of the
source file: <code>a.txt</cod
</tr>
</table>
</div>
-<div class="admonitionblock warning">
+<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
-<i class="fa icon-warning" title="Warning"></i>
+<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-<strong>If destination file exists</strong> doesn’t always do what its
name says. <strong>Create file with unique name</strong> builds a new name (the
date and time added after the file name, for example
<code>a.txt30102026_140920035</code>) but writes to the existing file, which is
overwritten; the new name, which doesn’t exist, is added to the result
files. <strong>Delete source file</strong> deletes the existing destination
file, not the source, and encrypts nothing. <stro [...]
+<strong>Create file with unique name</strong> adds the date and time after the
file name (for example <code>a.txt30102026_140920035</code>) and writes the
encrypted or signed data there. The existing file is left as it is.
</td>
</tr>
</table>
@@ -3313,7 +3317,7 @@ The encrypted or signed file keeps the name of the source
file: <code>a.txt</cod
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-The action has no passphrase option: for <strong>Sign</strong> and
<strong>Sign and encrypt</strong>, GnuPG must be able to use the signing key
without asking for one, for example a key without passphrase or a passphrase
already held by <code>gpg-agent</code>. Otherwise the file fails.
+For <strong>Sign</strong> and <strong>Sign and encrypt</strong>, put the
signing key’s passphrase in <strong>Passphrase</strong> when the key has
one. It is handed to GnuPG on standard input together with
<code>--pinentry-mode loopback</code>. An empty passphrase asks GnuPG to sign
without one.
</td>
</tr>
</table>