Remove Variable
Version: 17.07
Supported Since: 17.01
What is a Remove Variable Processor?
Remove Variable processing element can be used to remove an existing scope variable with a given key from the message context. It is possible either to remove the variable with the given key only from the current scope or from all the scopes.
|
Since this processing element belongs to the set of basic processing elements, this will be available for every project by default. |
Out Ports
Next |
The processing element will remove the specified scope variable from the message context and forward the message context to this outport |
On Exception |
The message context will be sent to this outport if any exception occurred while removing the scope variable |
Parameters
Variable Name * |
Basic |
Name of the variable to be removed. If a variable with the given name exists, it will be removed. This value is case sensitive. |
Remove from all scopes |
Basic |
Whether to remove the variable only from the current scope or from all the scopes. If this
parameter is set to |
Sample Use Case
In the following use case, a scope variable is added using an Add Variable processing element at the beginning. Then the message context goes through a custom processing element which performs some specific processing based on the value of that scope variable. After the custom processing element, a Remove Variable processing element is used to remove that scope variable from the message context, as it is no longer needed.
In this topic
In this topic