Configuring the To Client Executable Component |
 | ||
|
This documentation page describes a feature of version 3.3 of Iguana. In version 4.0 or later of Iguana, client executables are known as plugins. For information on how to configure the To Plugin destination component in version 4.0 or later of Iguana, see To Plugin. | ||
 |
The configuration details of the To Client Executable component are as follows:
| Property | Description |
|---|---|
| Full executable path | Executable path is the filename of the executable to be run. The client ID can be passed to the executable on the command line by using the token $CLIENTID$, e.g (MyExecutable.exe $CLIENTID$). |
| Full executable working directory | Indicates the working directory of the executable when it starts. |
| RPC timeout | Specifies the time in milliseconds before an error is logged, when Iguana dispatches an event to the executable. |
| Startup timeout | Specifies the time in milliseconds that Iguana will wait for a connection from the executable after it has been started. After it expires, an error is logged and the executable is killed. |
| Shutdown timeout | Specifies the time in milliseconds that Iguana will wait for the executable to be shut down after a shut down request has been issued. After it expires, an error is logged and the executable is killed. |
| Iguana starts executable | If set to false, the channel will wait for a connection from the external executable when it is started. As a result, the Startup Timeout, Shutdown Timeout, Full Executable Path and Full Executable Working Directory are not used. If set to true, Iguana will start up the defined executable and shut it down when the channel is stopped. |
| Automatically purge error logs older than | Specify when error logs are stale and can be deleted. If this value is 0, then error logs will never be automatically purged. |
| Edit Success/Error Log Fields (appears only after clicking Add Channel) | The Edit Success/Error Log Fields allow you to provide additional logging information related to the processing of a message. For more information, see Adding Custom Fields. To view a custom logging example, see Custom Logging Example. |