Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NOTE

  • If none of output or var parameters is set on a command, the result is by default always written to the body.

  • Only one of output or var can be defined. Not both.

output

Status
colourBlue
titleSince Version 8.0

Using this parameter you can define a Pipeline Expression (PEL) which specifies, where to write the result of the command to. The target can be at any location or sub-location of the current message. It can be in the vars scope but also can be used to add the result into the current body at some child-location for example. Here are some examples how to use this parameter:

...

This example will not write any result since the output parameter was set to false which means to skip any output of the command. This is handy in case you do not need the output of the command at all.

var

Status
colourBlue
titleSince Version 10

Another option to write the result of a command to a variable instead of the body is by using the var parameter. This parameter expects a string and sets the result of the command in the vars scope using this given variable name. It is a more easy readable way to save into the vars scope compared to the output param but has the same affect as the parameter output: ${vars.myVarName}.

...