This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/master by this push:
new 8fb30a8569 updated workflow action docs, fixes #2145
new 1220431b70 Merge pull request #2232 from bamaer/2145
8fb30a8569 is described below
commit 8fb30a8569e2479525bca44a4b3c786fb0918a9e
Author: Bart Maertens <[email protected]>
AuthorDate: Fri Feb 3 20:05:02 2023 +0100
updated workflow action docs, fixes #2145
---
.../ROOT/pages/workflow/actions/workflow.adoc | 73 +++++++++-------------
1 file changed, 31 insertions(+), 42 deletions(-)
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 4d4a8cc090..b043efcad6 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
@@ -45,84 +45,73 @@ See also:
== Options
-=== workflow Specification Tab
+=== Main workflow options
-[options="header"]
+[options="header", width="90%"]
|===
|Option|Description
|Action name|Name of the action.
-|Workflow Filename|Specify the XML file name of the workflow to execute.
-Click to browse through your local files.
+|Workflow Filename|Specify the XML file name of the workflow to execute. Click
to browse through your local files.
+|Run configuration a|The xref:metadata-types/workflow-run-config.adoc[workflow
run configuration] to use for this workflow action.
|===
-=== Advanced Tab
+=== Options Tab
-[options="header"]
+[%header, cols="1,3,1", width="90%"]
|===
-|Option|Description
-|Copy previous results to args?|The results from a previous workflow can
copied as arguments of the workflow using the "Copy rows to result" transform.
-If "Execute for every input row" is enabled then each row is a set of command
line arguments to be passed into the workflow, otherwise only the first row is
used to generate the command line arguments.
-|Copy previous results to parameters?|If "Execute for every input row" is
enabled then each row is a set of command line workflow arguments to be passed
into the workflow, otherwise only the first row is used to generate the command
line arguments.
+|Option|Description|Default
|Execute for every input row?|Implements looping; if the previous workflow
action returns a set of result rows, the workflow executes once for every row
found.
One row is passed to the workflow at every execution.
-For example, you can execute a workflow for each file found in a directory.
-|Remote slave server|The slave server on which to execute the workflow
-|Pass workflow export to slave|Pass the complete workflow (including
referenced sub-workflows and sub-pipelines) to the remote server.
-|Wait for the remote workflow to finish?|Enable to block until the workflow on
the slave server has finished executing
-|Follow local abort to remote workflow|Enable to send the abort signal to the
remote workflow if it is called locally
-|Expand child workflows and pipelines on the server|When the remote workflow
starts child workflows and pipelines, they are exposed on the slave server and
can be monitored.
+For example, you can execute a workflow for each file found in a
directory.|false
+|Wait for the remote workflow to finish?|Enable to block until the workflow on
the Hop Server has finished|true
|===
=== Logging Settings Tab
By default, if you do not set logging, Hop will take log actions that are
being generated and create a log record inside the workflow.
+
For example, suppose a workflow has three pipelines to run and you have not
set logging.
The pipelines will not output logging information to other files, locations,
or special configuration.
+
In this instance, the workflow executes and puts logging information into its
master workflow log.
-In most instances, it is acceptable for logging information to be available in
the workflow log.
+
+In most instances, it is acceptable for logging information to be available in
the workflow log. +
For example, if you have load dimensions, you want logs for your load
dimension runs to display in the workflow logs.
If there are errors in the pipelines, they will be displayed in the workflow
logs.
If, however, you want all your log information kept in one place, you must set
up logging.
-[options="header"]
+[options="header",cols="1,3,1", width="90%"]
|===
-|Option|Description
-|Specify logfile?|Enable to specify a separate logging file for the execution
of this workflow
-|Append logfile?|Enable to append to the logfile as opposed to creating a new
one
-|Name of logfile|The directory and base name of the log file; for example
C:\logs
-|Create parent folder|Create the parent folder for the log file if it does not
exist
-|Extension of logfile|The file name extension; for example, log or txt
-|Include date in logfile?|Adds the system date to the filename with format
YYYYMMDD (eg 20051231).
+|Option|Description|Default
+|Specify logfile?|Enable to specify a separate logging file for the execution
of this workflow|false
+|Name of logfile|The directory and base name of the log file; for example
C:\logs|none
+|Extension of logfile|The file name extension; for example, log or txt|none
+|Loglevel|Specifies the logging level for the execution of the workflow.|none
+|Append logfile?|Enable to append to the logfile as opposed to creating a new
one|false
+|Create parent folder|Create the parent folder for the log file if it does not
exist|false
+|Include date in logfile?|Adds the system date to the filename with format
YYYYMMDD (eg 20051231).|false
|Include time in logfile?|Adds the system time to the filename with format
HHMMSS (eg 235959).
-|Loglevel|Specifies the logging level for the execution of the workflow.
-See also the logging window in Logging
-|===
-
-=== Arguments Tab
-
-[options="header"]
-|===
-|Option|Description
-|Arguments|Specify which command-line arguments will be passed to the
sub-workflow.
+See also the logging window in Logging|false
|===
=== Parameters Tab
Specify which parameters will be passed to the sub-workflow:
-[options="header"]
+[options="header",cols="1,3,1", width="90%"]
|===
-|Option|Description
-|Pass all parameter values down to the sub-workflow|Enable this option to pass
all parameters of the workflow down to the sub-workflow.
-|Parameters|Specify the parameter names that will be passed to the workflow.
-|Stream column name|Allows you to capture fields of incoming records of a
result set as a parameter.
+|Option|Description|Default
+|Copy results to parameter|results from previous workflows or pipelines are
passed down to this workflows action's parameters|false
+|Pass parameter values down to the sub-workflow|Enable this option to pass all
parameters of the workflow down to the sub-workflow.|true
+|Parameters|Specify the parameter names that will be passed to the workflow.|-
+|Stream column name|Allows you to capture fields of incoming records of a
result set as a parameter.|-
|Value
a|Allows you to specify the values for the sub-workflow's parameters.
You can do this by:
* Manually typing some text (Ex: ETL workflow)
-* Using a parameter to set the value (Ex:
{openvar}Internal.workflow.Name{closevar})
-* Using a combination of manually specified text and parameter values (Ex:
{openvar}FILE_PREFIX{closevar}_{openvar}FILE_DATE{closevar}.txt)
+* Using a parameter to set the value (Ex:
`{openvar}Internal.workflow.Name{closevar}`)
+* Using a combination of manually specified text and parameter values (Ex:
`{openvar}FILE_PREFIX{closevar}_{openvar}FILE_DATE{closevar}.txt`)|-
|===
