| On this page | |
| Since | 18.0 |
This node passes input work items through unchanged, and can optionally report a node warning, node error, or work item error. If this node is inside a subnet or digital asset, then its error messages are also displayed on that asset. You can use this node to report errors or warnings to the user of an asset. For example, like issuing an error message that indicates a parameter value is invalid.
Errors are reported when their Report Error When expression evaluates to 1, otherwise the error is not reported. This expression can also refer to work item attributes.
TOP Attributes
|
|
str |
If Error Type is set to Work Item Error, then this attribute is created and set to the Error Message value for all work items that have an error. |
|
|
int |
If Error Type is set to Work Item Error, then this attribute is created and set to 1 for all work items that have an error. |
Parameters
Generate When
Determines when this node will generate work items. You should generally leave this set to "Automatic" unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.
All Upstream Items are Generated
This node will generate work items once all of the input nodes have generated their work items.
All Upstream Items are Cooked
This node will generate work items once all of the input nodes have cooked their work items.
Each Upstream Item is Cooked
This node will generate work items each time a work item in an input node is cooked.
Automatic
The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.
Evaluate Errors During
Determines when the node evaluates error conditions and produces messages.
Generate
The node evaluates error conditions and issues messages when work items are being generated.
Cook (In-Process)
The node evaluates error conditions and issues messages when work items are cooking.
Number of Errors
The number of error conditions to evaluate.
Error Type
The type of message to produce for each error condition that is met.
Node Warning
Produce a warning message on the node.
Node Error
Produce an error message on the node and halts any further evaluation of the node chain.
Note
If you want to provide error information without stopping node graph evaluation, then you should set Error Type to "Node Warning" instead.
Work Item Error
Produce error message on work items rather than the entire node.
Error Message
The error message to produce.
Report Error When
If this expression evaluates to a non-zero value, then the node reports the error or warning message.
Examples
CreateError Example for Error TOP node
This example demonstrates how to use the Error TOP node to create warnings or errors based on an expression.
| See also |
Subnetwork
Switch
