sramazzina commented on a change in pull request #481:
URL: https://github.com/apache/incubator-hop/pull/481#discussion_r546449464



##########
File path: 
plugins/transforms/tokenreplacement/src/main/doc/tokenreplacement.adoc
##########
@@ -0,0 +1,19 @@
+:documentationPath: /plugins/transforms/
+:language: en_US
+:page-alternativeEditUrl: 
https://github.com/apache/incubator-hop/edit/master/plugins/transforms/abort/src/main/doc/abort.adoc
+= Abort
+
+== Description
+
+This tranform type allows you abort a pipeline upon seeing input. It's main 
use is in error handling. For example, you can use this transform so that a 
pipeline can be aborted after x number of rows flow to over an error hop.
+
+== Options
+
+[width="90%", options="header"]
+|===
+|Option|Description
+|Transform name|Name of the transform.
+|Abort threshold|The threshold of number of rows after which to abort the 
pipeline. E.g. If threshold is 0, the abort transform will abort after seeing 
the first row. If threshold is 5, the abort transform will abort after seeing 
the sixth row.
+|Abort message|The message to put in the log upon aborting. If not filled in a 
default message will be used.
+|Always log|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.
+|===

Review comment:
       FIle has been cleaned up and ticket has been opened.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to