transformations:halt
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
transformations:halt [2021/11/12 22:27] – [See also] updated See Also section craigt | transformations:halt [2022/11/13 22:12] – update to Halt/Warn on condition craigt | ||
---|---|---|---|
Line 1: | Line 1: | ||
{{ transformations: | {{ transformations: | ||
- | ====== HALT ON CONDITION ====== | + | ====== HALT/WARN ON CONDITION ====== |
Category: Workflow / Internal \\ | Category: Workflow / Internal \\ | ||
\\ | \\ | ||
=====Description===== | =====Description===== | ||
- | This action | + | This action |
\\ | \\ | ||
=====Use cases===== | =====Use cases===== | ||
- | The purpose of this action is to monitor | + | *Monitor |
+ | *When working with Catalog items, Halt or Warn when data is outdated or possibly incomplete. | ||
+ | *In workflows, signal potential data quality issues and help to investigate errors. | ||
\\ | \\ | ||
=====Action settings===== | =====Action settings===== | ||
^Setting^Description^ | ^Setting^Description^ | ||
- | |Halt mode|Select the condition under which the project is halted. | + | |Mode|Options: // |
- | |Error message|(Optional) Enter custom text that will appear in the error message if an error occurs.| | + | |
- | \\ | + | \\ |
====Halt mode options==== | ====Halt mode options==== | ||
^Halt mode ^Description ^ | ^Halt mode ^Description ^ | ||
Line 23: | Line 25: | ||
|Halt if the condition is true for EVERY row|The option stops the action chain if the entered condition evaluates to TRUE for every row in the dataset at the time of the Halt action.| | |Halt if the condition is true for EVERY row|The option stops the action chain if the entered condition evaluates to TRUE for every row in the dataset at the time of the Halt action.| | ||
|Halt if the condition is true for ANY row|The option stops the action chain if the entered condition evaluates to TRUE for any row in the dataset at the time of the Halt action.| | |Halt if the condition is true for ANY row|The option stops the action chain if the entered condition evaluates to TRUE for any row in the dataset at the time of the Halt action.| | ||
+ | |Error message|(Optional) Enter custom text that will appear in the error message if an error occurs.| | ||
- | For either of the " | + | \\ |
+ | ====Warn and continue mode options==== | ||
+ | ^Warn mode ^Description ^ | ||
+ | |Warn if table is empty|This option displays a warning and continues if the dataset is empty at the point of the Warn action.\\ | ||
+ | |Warn if table is NOT empty|This option displays a warning and continues if the dataset is NOT empty at the point of the Warn action. | ||
+ | |Warn if the condition is true for EVERY row|The option displays a warning and continues if the entered condition evaluates to TRUE for every row in the dataset at the time of the Warn action.| | ||
+ | |Warn if the condition is true for ANY row|The option displays a warning and continues if the entered condition evaluates to TRUE for any row in the dataset at the time of the Warn action.| | ||
+ | |Warning message|(Optional) Enter custom text that will appear in the warning message if an error occurs.| | ||
+ | |||
+ | \\ | ||
+ | For either of the " | ||
\\ | \\ | ||
=====Remarks===== | =====Remarks===== | ||
- | The condition must return either TRUE or FALSE for each row. If for some reason, it returns an error then the action will also fail.\\ | + | The condition must return either TRUE or FALSE for each row. If for some reason it returns an error then the action will also fail.\\ |
If the condition is global (i.e. doesn' | If the condition is global (i.e. doesn' | ||
- | The error message can be customized to provide more insight into the cause of the interruption. | + | The error message can be customized to provide more insight into the cause of the interruption. |
\\ | \\ | ||
Line 46: | Line 59: | ||
|QC | 2000| | |QC | 2000| | ||
\\ | \\ | ||
- | **Action parameters: | + | **Action parameters |
> Halt mode is "Halt if the condition is true for ANY row" | > Halt mode is "Halt if the condition is true for ANY row" | ||
> The condition is "not isnumber([Amount])" | > The condition is "not isnumber([Amount])" | ||
Line 52: | Line 65: | ||
This will make the action stop project execution because one of the values in column " | This will make the action stop project execution because one of the values in column " | ||
+ | |||
+ | \\ | ||
+ | **Action parameters (Warn and continue mode):** | ||
+ | > Warn mode is "Warn if the condition is true for ANY row" | ||
+ | > The condition is "not isnumber([Amount])" | ||
+ | > Choose "Do NOT warn" if the dataset has no rows | ||
+ | |||
+ | The action will display a warning and continue project execution because one of the values in column " | ||
+ | |||
\\ | \\ |
transformations/halt.txt · Last modified: 2023/10/13 21:38 by craigt