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 ecda59667d Document the Open button next to the pipeline or workflow
file in transform and action dialogs, fixes #9379 (#9382)
ecda59667d is described below
commit ecda59667d58d6f8dcc5326496903b4b6853558c
Author: Adalennis <[email protected]>
AuthorDate: Sun Nov 8 08:57:13 2026 +0100
Document the Open button next to the pipeline or workflow file in transform
and action dialogs, fixes #9379 (#9382)
---
.../ROOT/pages/pipeline/transforms/azure-event-hubs-listener.adoc | 3 ++-
.../modules/ROOT/pages/pipeline/transforms/kafkaconsumer.adoc | 1 +
.../modules/ROOT/pages/pipeline/transforms/metainject.adoc | 1 +
.../modules/ROOT/pages/pipeline/transforms/multi-mapping.adoc | 4 +++-
.../modules/ROOT/pages/pipeline/transforms/pipeline-executor.adoc | 1 +
.../modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc | 1 +
.../modules/ROOT/pages/pipeline/transforms/workflow-executor.adoc | 1 +
.../hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc | 1 +
docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc | 1 +
.../hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc | 1 +
10 files changed, 13 insertions(+), 2 deletions(-)
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 594999dbfd..54d706a029 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
@@ -59,7 +59,8 @@ Please note you can use a transform like JSON Output or "Java
Script" to assembl
In order to make sure that all records are processed safely before we
checkpoint the events stream, we need to run all logic we need to run, update
everything we need to update, before we do so.
To do this we pass all the rows we read in one batch to the specified batch
pipeline (which will run single threaded)
-* Batch pipeline: the batch pipeline file name
+* Batch pipeline: the batch pipeline file name.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
* pipeline input transform: the name of the "Injector" or "Get records from
Stream" transform to send the events to in the batch pipeline.
* pipeline output transform: (optional) the name of the transform to read from
in the batch pipeline and to use as output of this Listener transform.
* Maximum wait time (ms): (optional but highly recommended!) The maximum time
to wait before the batch pipeline is executed despite the fact that you might
not have the specified number of records in the batch.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/kafkaconsumer.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/kafkaconsumer.adoc
index 11bf38d132..d94fd726e4 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/kafkaconsumer.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/kafkaconsumer.adoc
@@ -57,6 +57,7 @@ For example, you can run the parent pipeline on a timed
schedule, drain a topic
|Transform name|The name for this transform
|Kafka pipeline
|Specify the pipeline to execute by entering its path or clicking _Browse_ and
selecting the path.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
*Note:* this pipeline *must* start with an Injector transform.
|===
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/metainject.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/metainject.adoc
index 56d3f2bd15..eb7d79de8d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/metainject.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/metainject.adoc
@@ -53,6 +53,7 @@ xref:pipeline/metadata-injection.adoc[Read more on metadata
injection]
|Transform name|Name of the transform.
|Pipeline|Specify your template pipeline by entering in its path.
Click Browse to display and enter the path details using the Virtual File
System Browser.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
If you select a pipeline that has the same root path as the current pipeline,
the variable +${Internal.Transform.Current.Directory}+ will automatically be
inserted in place of the common root path.
For example, if the current pipeline's path is /home/admin/pipeline.hpl and
you select a pipeline in the folder /home/admin/path/sub.hpl then the path will
automatically be converted to
+${Internal.Transform.Current.Directory}/path/sub.hpl+.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/multi-mapping.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/multi-mapping.adoc
index c67bc39494..cc0a18004b 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/multi-mapping.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/multi-mapping.adoc
@@ -42,7 +42,9 @@ The child pipeline is always executed with a local Hop
pipeline run configuratio
== Options
* Transform name: a unique name in your pipeline
-* Pipeline: the mapping (sub-) pipeline to run
+* Pipeline: the mapping (sub-) pipeline to run.
+Click *Edit* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
+*New* creates an empty pipeline file and selects it.
* Run configuration: local Hop run configuration only
* Parameters tab: variables to pass into the child, plus inherit-all-variables
* Input tabs (Add Input): one tab per input mapping
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-executor.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-executor.adoc
index e926faeedb..44a4de16c6 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-executor.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-executor.adoc
@@ -83,6 +83,7 @@ You have the following options to specify the pipeline:
- Use a file for the pipeline: when this option is enabled, you can enter the
.hpl file that is to be used as pipeline.
The filename may contain variables (for example, you can use the built-in
Internal.Pipeline.Filename.Directory variable to construct a filename relative
to the current pipeline), or you can use the "Browse" button to select a file
using a file browser.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them. *Open* is not available when *Pipeline from
field?* is enabled.
|Pipeline from field?|Enable to specify the pipeline file name(s) in a field
in the input stream
|Pipeline field|When the previous option is enabled, you can specify the field
that will contain the pipeline filename(s) at runtime. The filename may contain
variables.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
index 8684187ed7..599e883e90 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
@@ -49,6 +49,7 @@ The options are fairly self-explanatory:
* Transform name: a unique name in your pipeline
* Pipeline: The name of the mapping (sub-) pipeline to embed.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
This pipeline is executed separately and is considered a separate entity.
It is always executed with a standard local Hop pipeline run configuration
since that is currently the only one capable of streaming data into and out of
transforms.
* Parameters tab: specify the parameters you want to pass to the mapping
pipeline
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/workflow-executor.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/workflow-executor.adoc
index 6e9dcac7b2..b7a96e3fad 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/workflow-executor.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/workflow-executor.adoc
@@ -60,6 +60,7 @@ Samples (samples project)
|Transform name|Name of the transform.
|Workflow|Use this option to specify a workflow stored in a file (.hwf file).
The filename may contain variables (for example, you can use the built-in
Internal.Pipeline.Filename.Directory variable to construct a filename relative
to the current pipeline), or you can use the "Browse" button to select a file
using a file browser.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them. *Open* is not available when *Workflow from
field?* is enabled.
|Workflow from field?|Enable to specify the workflow file name(s) in a field
in the input stream.
|Workflow field|When the previous option is enabled, you can specify the field
that will contain the workflow filename(s) at runtime. The filename may contain
variables.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
index 38f9dd7730..826a1fbe38 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
@@ -46,6 +46,7 @@ See also:
|Option|Description
|Action name|Name of the action.
|Pipeline|Specify your pipeline by entering in its path or clicking Browse.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
The selected pipelines will automatically converted to a path relative to your
`+${PROJECT_HOME}+`. +
For example, if your `+${PROJECT_HOME}+` is `/home/admin/hop/project/` and you
select a pipeline `/home/admin/hop/project/subfolder/sub.hpl` than the path
will automatically be converted to `+${PROJECT_HOME}/subfolder/sub.hpl+`.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
index 9e3223d700..8a249556fb 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat.adoc
@@ -48,6 +48,7 @@ This variable is detected by the Repeat action, and the loop
stops. Because the
|Action name|The name of the workflow action.
|File to repeat (.hpl or .hwf)|The filename of the pipeline or workflow to
execute repeatedly.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
|Run configuration a|The pipeline or workflow run configuration to use.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
index 5cff5631a3..04bfdf257e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/workflow.adoc
@@ -51,6 +51,7 @@ See also:
|Option|Description
|Action name|Name of the action.
|Workflow Filename a|Specify the XML file name of the workflow to execute.
Click to browse through your local files.
+Click *Open* to open it in Hop Gui. When the dialog has unsaved changes, Hop
first asks whether to save them.
The selected workflow will automatically converted to a path relative to your
`+${PROJECT_HOME}+`.