From Plugin (legacy)

Configure the settings for the legacy From Plugin source component.

The From Plugin allows you to use an external plugin executable.

  • Click the Edit Channel button
  • Enter your settings and click Save Changes

Iguana starts executable

  • Select this option to start the plugin when the channel is started and shut it down when the channel is stopped
    Note: If the option not selected, the channel waits for a connection from the plugin

Full executable path

  • Enter the location of the plugin executable

    Tip: You can use an environment variable in the path, i.e., ${iguana_dir}myfile.exe will include the Iguana working directory in the path:

    This same technique can be use in any directory path in all Iguana settings

Working directory

  • Choose the directory type from the listbox
  • If you chose Use alternate directory you will need to enter the directory

Executable parameters

  • Enter startup parameters for the plugin
  • These macros can be included as executable parameters:
    Macro Description
    $hostname$  The host name of the Iguana Server.
    $port$ The port number of the Iguana Server.
    $channel$ The name of the Iguana channel.
    $component$ Set to source if the plugin is communicating with a source component (as it is here), or to destination if the plugin is communicating with a destination component.
    $clientid$ A string consisting of the channel name with source1 appended (for example, mychannelname.source1). This macro is provided for plugins that use the deprecated connect method, which expects this as a parameter.If you are creating a new plugin, use $channel$ and $component$ instead of $clientid$.
  • <stuff about vars in params>

Startup timeout

  • Enter the time in milliseconds to wait for a connection from the plugin after it has been started
    Note: After this time has elapsed an error is logged and the plugin is terminated

Shutdown timeout

  • Enter the time, in milliseconds to wait for the plugin to be shut down after a shutdown request has been issued
    Note: After this time has elapsed an error is logged and the plugin is terminated

Polling time

  • Enter the polling time in milliseconds (minimum = 10 milliseconds)
    This is the amount of time between attempts to obtain a message from the plugin if no message was found at the last attempt

Plugin timeout

  • Enter the time in milliseconds to wait after an event is sent to the plugin before an error is logged

Diagnostic tools

  • Click the Monitor executable output link to display the output that is being written to the plugin

Leave A Comment?