This is an automated email from the ASF dual-hosted git repository.
bamaer 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 f4368f1eac Transform pages: Samples section for Abort to Check if file
is locked, addresses #9469 (#9485)
f4368f1eac is described below
commit f4368f1eac991105ba40e5e4bd472ff7b2eaeaf5
Author: Adalennis <[email protected]>
AuthorDate: Sat Nov 14 15:32:43 2026 +0100
Transform pages: Samples section for Abort to Check if file is locked,
addresses #9469 (#9485)
---
.../modules/ROOT/pages/pipeline/transforms/abort.adoc | 4 ++++
.../modules/ROOT/pages/pipeline/transforms/accessoutput.adoc | 7 ++++++-
.../modules/ROOT/pages/pipeline/transforms/addchecksum.adoc | 6 ++++++
.../modules/ROOT/pages/pipeline/transforms/addconstant.adoc | 6 +++++-
.../modules/ROOT/pages/pipeline/transforms/addsequence.adoc | 9 ++++++++-
.../modules/ROOT/pages/pipeline/transforms/addxml.adoc | 6 +++++-
.../modules/ROOT/pages/pipeline/transforms/analyticquery.adoc | 5 +++++
.../modules/ROOT/pages/pipeline/transforms/append.adoc | 4 ++++
.../modules/ROOT/pages/pipeline/transforms/aws-sns-notify.adoc | 5 +++++
.../modules/ROOT/pages/pipeline/transforms/aws-sqs-reader.adoc | 7 ++++++-
.../pages/pipeline/transforms/azure-event-hubs-listener.adoc | 5 +++++
.../ROOT/pages/pipeline/transforms/azure-event-hubs-writer.adoc | 4 ++++
.../ROOT/pages/pipeline/transforms/blockingtransform.adoc | 6 +++++-
.../pages/pipeline/transforms/blockuntiltransformsfinish.adoc | 7 ++++++-
.../modules/ROOT/pages/pipeline/transforms/calculator.adoc | 7 +++++++
.../modules/ROOT/pages/pipeline/transforms/calldbproc.adoc | 7 ++++++-
.../ROOT/pages/pipeline/transforms/changefileencoding.adoc | 4 ++++
.../modules/ROOT/pages/pipeline/transforms/checkfilelocked.adoc | 4 ++++
18 files changed, 95 insertions(+), 8 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/abort.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/abort.adoc
index bd824b2f9e..35e07615df 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/abort.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/abort.adoc
@@ -51,3 +51,7 @@ The Abort transform features the following logging options:
| Abort message | The message to put in the log upon aborting. If not
filled in a default message will be used.
| Always log rows | Always log the rows processed by the Abort transform.
This allows the rows to be logged although the log level of the pipeline would
normally not do it. This way you can always see in the log which rows caused
the pipeline to abort.
|===
+
+== Samples
+
+The samples project has `transforms/abort-basic.hpl`: a Filter rows transform
sends the row with `id` 4 to Abort, which stops the pipeline with an error.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/accessoutput.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/accessoutput.adoc
index be7f997423..a40c95dd5d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/accessoutput.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/accessoutput.adoc
@@ -37,4 +37,9 @@ Note: This name has to be unique in a single pipeline.
|Target table|Specifies the table to which you want to output data
|Create table|Enable to create a new table in the Access database
|Commit size|Defines the commit size when outputting data
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/microsoft-access-output.hpl`, which writes
two rows from a Data grid to a Microsoft Access file.
+Set the file name and the table name in the transform before you run it.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addchecksum.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addchecksum.adoc
index 1806e7041d..15986fdbaa 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addchecksum.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addchecksum.adoc
@@ -65,3 +65,9 @@ Note: You can use the "Get Fields" button to insert all input
fields from previo
* xref:how-to-guides/cdc-snapshot-comparison.adoc[CDC: comparing snapshots] —
storing an MD5 or SHA hash of a row and comparing it on the next run
* xref:pipeline/transforms/combinationlookup.adoc[Combination lookup/update] —
store this hash code on a junk dimension, or let that transform read a hash you
calculated here
+== Samples
+
+The samples project has:
+
+* `transforms/add-a-checksum-CRC32.hpl`, which adds a CRC32 checksum of three
fields to the rows of a Data grid.
+* `transforms/add-a-checksum-SHA-512.hpl`, which adds a hexadecimal SHA-512
checksum of the same three fields.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addconstant.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addconstant.adoc
index 5a33ee8409..c1ab7b64ec 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addconstant.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addconstant.adoc
@@ -51,4 +51,8 @@ See xref:concepts.adoc#data-types[Data types].
|===
IMPORTANT: *Value* is a *single* constant per field.
-*Group* is the thousands separator, not a row group.
\ No newline at end of file
+*Group* is the thousands separator, not a row group.
+
+== Samples
+
+The samples project has `transforms/add-constants.hpl`, which adds a constant
of each data type (BigNumber, Boolean, Date, Integer, Number, String and
Timestamp) to a generated row.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addsequence.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addsequence.adoc
index d65640d069..8deb5d93ac 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addsequence.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addsequence.adoc
@@ -68,4 +68,11 @@ Avoids forcing unique sequencing across multiple transforms.
|Start field|Field in the configuration row that contains the value to begin
the sequence with.
|End field|Field in the configuration row that contains the maximum value.
After this value the sequence returns to the start value.
|Increment field|Field in the configuration row that contains the amount by
which the sequence increases or decreases.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has:
+
+* `transforms/add-sequence-unique-id.hpl`, which numbers 100 generated rows
from 1 to 100 and writes the numbers to the log.
+* `transforms/add-sequence-cyclic-id.hpl`, which counts from 1 to 10 and then
starts at 1 again, because the maximum value is 10.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addxml.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addxml.adoc
index 1c6a0695f2..75f52e87b0 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addxml.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/addxml.adoc
@@ -121,4 +121,8 @@ You want to turn the raw data into the database layout
below.
|1|6|3|<SHAPE type="rectangle"><COLOUR>blue</COLOUR><WIDTH> 4</WIDTH><LENGTH>
6</LENGTH></SHAPE>
|2|8|8|<SHAPE type="rectangle"><COLOUR>blue</COLOUR><WIDTH>
4</WIDTH><LENGTH>6</LENGTH></SHAPE>
|5|5|2|<SHAPE type="circle"><COLOUR>blue</COLOUR><RADIUS> 5</RADIUS></SHAPE>
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/add-xml-basic.hpl`, which turns each Data
grid row into a `row` XML element in the new field `xmlvaluename`, with `group`
as an attribute and the other three fields as child elements.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/analyticquery.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/analyticquery.adoc
index 40b8e4d997..e71118d0c4 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/analyticquery.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/analyticquery.adoc
@@ -108,4 +108,9 @@ bbb , 6 , 5
Thus, by grouping (provided the input is sorted according to your grouping),
you can be assured that lead or lag operations will not return row values
outside of the defined group.
+== Samples
+The samples project has:
+
+* `transforms/analyticquery-basic.hpl`, which adds the previous and the next
`desc` (LAG and LEAD) to each row.
+* `transforms/analyticquery-grouped.hpl`, which does the same within each `id`.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/append.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/append.adoc
index d90a9e2afd..1a63a7c80d 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/append.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/append.adoc
@@ -39,3 +39,7 @@ Note: This name has to be unique in a single pipeline.
|Head hop|The name of the transform from which will be read the first stream.
|Tail hop|The name of the transform from which will be read the second stream.
|===
+
+== Samples
+
+The samples project has `transforms/append-streams-basic.hpl`, which sends the
10 rows of *Second Stream* (Head hop) and then the 10 rows of *First Stream*
(Tail hop) to one output.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sns-notify.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sns-notify.adoc
index f1ad0c9511..970bd3c588 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sns-notify.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sns-notify.adoc
@@ -67,3 +67,8 @@ All rows can be specified either from a field (`F` column) or
as a static value
** Message: the message you want to send
|===
+
+== Samples
+
+The samples project has `transforms/aws-sns-notify.hpl`, which sends one
notification for the first row of a Data grid.
+Fill in the AWS credentials, the topic ARN, the subject and the message before
you run it.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sqs-reader.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sqs-reader.adoc
index fcf452dfb3..a60057f44b 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sqs-reader.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/aws-sqs-reader.adoc
@@ -68,4 +68,9 @@ On the Output Definition Tab you can define the output fields
for the informatio
|ReceiptHandle|Unique identifier for receiving a message.
|MD5 Hash|MD5 hash of the message body
|Message Node from SNS|if the message was sent from SNS this field will
contain the content of the JSON node "Message" within the Message body.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/aws-sqs-reader.hpl`, which reads messages
from the `sample-queue` queue in `eu-west-1`.
+It needs AWS credentials and an existing queue.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-listener.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-listener.adoc
index 54d706a029..07be7016f6 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-listener.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-listener.adoc
@@ -77,3 +77,8 @@ It receives the following fields:
* sequenceNumber (Integer)
* host (String)
* enqueuedTime (Timestamp)
+
+== Samples
+
+The samples project has `transforms/azure-event-hubs-listener.hpl`, which
listens for messages with the `$Default` consumer group.
+Fill in the Event Hubs connection settings before you run it.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-writer.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-writer.adoc
index c673eee838..d71b3a6ede 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-writer.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/azure-event-hubs-writer.adoc
@@ -38,3 +38,7 @@ This needs to be a policy with the "Send" claim enabled.
* Message field: the field containing the message to use as the events.
Please note you can use a transform like JSON Output or "Java Script" to
assemble the message.
+== Samples
+
+The samples project has `transforms/azure-event-hubs-writer.hpl`, which sends
one event per row of a Data grid to an event hub.
+Fill in the Event Hubs connection settings and choose `id` or `name` as the
Message field before you run it.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockingtransform.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockingtransform.adoc
index f29d490f0b..2997cc0546 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockingtransform.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockingtransform.adoc
@@ -45,4 +45,8 @@ You can also give a variable: when it is set, its value (Y or
N) decides whether
|Compression level|How hard to compress the spool files: 1 - Fastest, 2 - Very
fast, 3 - Fast, 4 - Balanced, faster, 5 - Balanced, 6 - Standard (the Java
default), 7 - Smaller files, 8 - Very small files, 9 - Smallest files.
Spool files are read back only once, so a low level is usually best.
A new transform uses 1 - Fastest. A transform saved before this option existed
keeps 6 - Standard, the level it always used.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/blockingtransform-basic.hpl`, which
generates 100,000 random UUIDs and passes them on only after the last one has
arrived.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockuntiltransformsfinish.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockuntiltransformsfinish.adoc
index 8c57621c14..ddad1ce14f 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockuntiltransformsfinish.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/blockuntiltransformsfinish.adoc
@@ -44,4 +44,9 @@ You can use it to avoid the natural concurrency (parallelism)
that exists betwee
|CopyNr|The (0-based) copy number of the transform.
If the named transform has an explicit setting for "Change number of copies to
start", and you want to wait for all copies to finish, you'll need to enter one
row in the grid for each copy, and use this column to specify which copy of the
transform to wait for.
For the default number of copies (1), the CopyNr is always 0.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/block-until-transforms-finish-basic.hpl`:
the row from *1 row* waits until *Found GOD!* has finished before it goes on to
a JavaScript transform.
+*Found GOD!* gets 1,000 rows, each delayed by one second, so the pipeline
takes about 17 minutes.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calculator.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calculator.adoc
index 5e5e5a621e..5e46d8942d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calculator.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calculator.adoc
@@ -231,3 +231,10 @@ In short: we convert to the required metadata type when we
land the data somewhe
*A*: You might notice that if you multiply an Integer and Number, the result
is always rounded.
That is because Calculator takes data type of the left hand size of the
multiplication (A) as the driver for the calculation.
As such, if you want more precision, you should put field B on the left hand
side or change the data type to Number and all will be well.
+
+== Samples
+
+The samples project has:
+
+* `transforms/calculator-basic.hpl`, which subtracts, adds, multiplies and
divides two numbers from a Data grid.
+* `transforms/calculator-jde-julian.hpl`, which converts dates to JD Edwards
Julian dates (CYYDDD) and back.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calldbproc.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calldbproc.adoc
index 73da6e2ae3..dade464fe3 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calldbproc.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/calldbproc.adoc
@@ -78,4 +78,9 @@ This tab is available when the result type is *Row*. The
listed columns are appe
|Format|Optional conversion mask.
|Length|Field length. Empty means unspecified.
|Precision|Field precision. Empty means unspecified.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/call-db-procedure.hpl`, which calls H2's
built-in `LENGTH` function for two rows through the `hop-samples` connection.
+To call a stored procedure of your own, change the connection and the
procedure name.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/changefileencoding.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/changefileencoding.adoc
index 609549cc07..46955af12e 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/changefileencoding.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/changefileencoding.adoc
@@ -39,3 +39,7 @@ The Change File Encoding transform changes a text file from
one encoding to anot
** Target encoding: you can select the target encoding here
** Add target filename to the result filenames?
: Check this if you want to add the target file(s) automatically to the files
list of the result of the pipeline.
+
+== Samples
+
+The samples project has `transforms/change-file-encoding.hpl`, which converts
`files/change-file-encoding.txt` from UTF-8 to ISO-8859-1 into
`output/change-file-encoding.txt`.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/checkfilelocked.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/checkfilelocked.adoc
index 8cbd64f871..c49dd33769 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/checkfilelocked.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/checkfilelocked.adoc
@@ -31,3 +31,7 @@ The Check If A File Is Locked transform tries to determine if
a file is locked b
* Filename field: the name of the input field that will contain the names of
the files during execution.
* Result fieldname: the name of the Boolean output field that will contain
true or false depending on whether or not the file is locked or not.
* Add filename to result: check this if you want to add the checked file-names
to the list of files in the pipelines result.
+
+== Samples
+
+The samples project has `transforms/check-if-file-is-locked-basic.hpl`, which
finds `customers-100.txt` in the project, checks whether it is locked and
writes the result to the log.