execute

Execute

Icon
Use When	There is a need to execute an operating system command as part of a flow
Samples
Description	The execute component executes an operating system command on the host on which the agent is running.
Inbound Message Type	Any Message Type
Output Message Type	Text Based Message
Control Message Handling	Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is not 'PER UNIT OF WORK'. Output: A single control message will be forwarded to downstream components once all commands have been processed through this step.

Properties

Name	Description
Error Suspense Step	Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to.
Enabled
Run When
Command	The operating system command to be executed for every inbound message to the component
Continue on Error	Whether the flow should continue if the Command fails to execute properly
Success Code	The code that should be returned in the text based outbound message if the Command is successful
Parameter replacement	Enables token replacement for the Command. Message headers and flow parameters can be token replaced. The following token formats can be used: $(HeaderKey) or $(FlowParameter). Note that you can link:Stamp entity and text message values in a message header if you want to use message values.
Log Input
Log Output
Inbound Queue Capacity