This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new ae8632cd40 Fix outdated hop-conf options and variable details in the
variables, Azure VFS and Set Variables pages, fixes #9008 (#9025)
ae8632cd40 is described below
commit ae8632cd40047186e3329380ba966b411b1531b1
Author: Adalennis <[email protected]>
AuthorDate: Tue Oct 20 15:37:36 2026 +0200
Fix outdated hop-conf options and variable details in the variables, Azure
VFS and Set Variables pages, fixes #9008 (#9025)
* Fix outdated hop-conf options and variable details in the variables,
Azure VFS and Set Variables pages. #9008
* Inside pipelines and workflows, a system variable keeps the value from
the System variables tab. #9008
---
.../pages/pipeline/transforms/setvariable.adoc | 4 +--
.../modules/ROOT/pages/variables.adoc | 29 ++++++++++++++--------
.../ROOT/pages/vfs/azure-blob-storage-vfs.adoc | 14 +++++------
3 files changed, 27 insertions(+), 20 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/setvariable.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/setvariable.adoc
index a6b8196d73..db1c711140 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/setvariable.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/setvariable.adoc
@@ -38,7 +38,7 @@ See xref:fields-parameters-variables.adoc[Fields, parameters,
and variables].
A variable can be set in one pipeline and be available in the next pipeline
(named pipeline) that is in the loop of a pipeline executor. If you are using
a pipeline executor child, the parent pipeline does not restart and does not
get any set variables. The new variable name to set in a child pipeline is
shown below in the second column.
-TIP: This transform accepts one (and only one) row of data to set the value of
a variable. If you want to set a variable from a pipeline that processes
multiple lines of data, make sure you isolate a single row before setting a
variable.
+TIP: This transform accepts one (and only one) row of data to set the value of
a variable. With more than one row the transform fails with the error "Only 1
input row was expected to set the variables and at least 2 were received". If
you want to set a variable from a pipeline that processes multiple lines of
data, make sure you isolate a single row before setting a variable.
WARNING: You can't set and use a variable in the same pipeline. Since all
transforms in a pipeline run in parallel, there is no way a transform in a
pipeline can use a variable that is set in another transform in that same
pipeline.
@@ -59,7 +59,7 @@ Otherwise no formatting is done.
* Valid in the grand-parent: the variable is valid in the grand-parent
workflow or pipeline and all child workflows and pipelines.
* Valid in the root: the variable is valid in the root workflow or pipeline
and all child workflows and pipelines.
-|Default value|Value that will be set for empty rows
+|Default value|Value that is set when the transform receives no row. A field
that is empty sets an empty value, not the default value.
|===
[NOTE]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
b/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
index fdd60e7d18..865b24f0f5 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/variables.adoc
@@ -170,32 +170,39 @@ The exact rules that decide which value a parameter ends
up with when one pipeli
=== System properties
-All system properties are variables that are available in all of your
currently running Apache Hop instance. System properties are available as
variables as well as all Java system properties.
+All Java system properties are available as variables in your running Apache
Hop instance, for example `+${java.io.tmpdir}+` or `+${user.home}+`.
+You can set your own with `-D` options in `HOP_OPTIONS`, or with the `-s`
option of xref:hop-run/index.adoc[hop-run].
System properties get set in the Java Virtual Machine that runs your Apache
Hop instance. This means that you should limit yourself to only those variables
which are really system specific.
-You can add your own system variables to the ones that come with Apache Hop by
default in the `System Variables` tab in the configuration perspective.
+You can also add your own system variables in the `System variables` tab of
the configuration perspective.
+They are available as variables in every pipeline and workflow, and Hop also
sets them as Java system properties when it starts, unless a property with the
same name was already set with `-D`.
+Inside pipelines and workflows, `+${MY_SYSTEM_VARIABLE}+` still resolves to
the value from this tab.
image::variables/system-variables.png[The system variables tab in Hop GUI,
width="65%"]
-These variables will be written to the `hop-config.json` file in your hop
installation's `config` folder or in your `+${HOP_CONFIG_FOLDER}+` location.
+These variables are written to the `hop-config.json` file in your hop
installation's `config` folder or in your `+${HOP_CONFIG_FOLDER}+` location.
CAUTION: even though you _can_ manually change the `hop-config.json` or any of
the other configuration files, you'll rarely, if ever, need to. Only change
`hop-config.json` manually if you know what you're doing.
[source,json]
+----
{
- "systemProperties" : {
- "MY_SYSTEM_PROPERTY" : "SomeValue"
- }
+ "variables" : [ {
+ "name" : "MY_SYSTEM_VARIABLE",
+ "value" : "SomeValue",
+ "description" : "What this variable is for"
+ } ]
}
+----
-
-You can also use the hop-config command line tool to define system properties:
+You can also set and describe them with the
xref:hop-tools/hop-conf/hop-conf.adoc[hop-conf] command line tool:
[source,bash]
-sh hop-conf.sh -s MY_SYSTEM_PROPERTY=SomeValue
-
-
+----
+sh hop-conf.sh --set-variable=MY_SYSTEM_VARIABLE=SomeValue
+sh hop-conf.sh --describe-variable="MY_SYSTEM_VARIABLE=What this variable is
for"
+----
=== Environment Variables
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
b/docs/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
index 5cda6fcae2..2ac09700b8 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
@@ -39,17 +39,18 @@ To get access to your Azure storage files you need to
configure a few things:
You can find both in the Storage Accounts section of your Azure portal.
-* A file block size : This needs to be a multiple of 512 bytes.
+For tests and development you can use an Azure emulator such as Azurite
instead, by setting its URL.
-All 3 options can be set in either the Hop GUI options dialog (Menu: Tools /
Options) or using the following Hop Conf (`hop-conf.sh` or `hop-conf.bat`)
command line options:
+These options can be set in the *Plugins* section of the
xref:hop-gui/perspective-configuration.adoc[configuration perspective] or with
the following Hop Conf (`hop-conf.sh` or `hop-conf.bat`) command line options:
[source,shell script]
----
-aza, --azure-account=<account>
The account to use for the Azure VFS
- -azi, --azure-block-increment=<blockIncrement>
- The block increment size for new files on Azure,
- multiples of 512 only.
+ -aze, --azure-emulator=<emulatorUrl>
+ The URL of an Azure emulator (Azurite) to be used
+ for test and development goals instead of
+ official Azure services
-azk, --azure-key=<key>
The key to use for the Azure VFS
@@ -62,8 +63,7 @@ Once done you will see an `azure` entry in the central
`hop-config.json` file:
{
"azure" : {
"account" : "storage-account-name",
- "key" : "a/key-comprised-of-a-long-set-of-characters-and-numbers==",
- "blockIncrement" : "1024"
+ "key" : "a/key-comprised-of-a-long-set-of-characters-and-numbers=="
}
}
----
