To Plugin (legacy)


Configure the settings for the legacy To Plugin (legacy) destination component.

The To 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$.

Tip: You can include environment variables in the Executable parameters field, i.e., ${name}, where name is the name of the environment variable.

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

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

Legacy database logging [top]

Legacy database logging

  • Check the box to enable logging

Database API

  • Select the database to use from the listbox

Data source

  • Enter name of the database

Database username

  • Enter the username (if required)

Database password

  • Enter the password (if required)

Log table constant

  • optionally type a constant to uniquely identify the database tables that will contain log information.

    Note: This constant will be added as a prefix to the name of the database table containing log information, and will be added as a postfix to the name of the database table containing the index information. If you leave this field blank, the default is to use the channel name, converted to lower case and with white space removed, as the log table constant.

    For  example: If your channel is named plugin and you do not specify a Log table constant, the log table is named plugin_dest1_inb_exe_mes_suc and the index table is named log_indices_plugin.

Purge logs

  • Select this option to automatically purge the log table for you
  • Enter the number of days to wait before purging log table entries
    Note: This field only appears if you select the purge option

Custom DB columns

  • Enter the names of additional columns contained in the table (names must be separated by semi-colon “;” characters)

Reconnect to DB

  • Choose if you want Iguana to try and reconnect to the database wen the connection is lost
  • If you select Yes, with limit you must specify the number of retries

Reconnection interval

  • Enter the delay between retries in milliseconds (default = 10000 milliseconds)
    Note: this field is only displayed if you choose Yes, with limit above

Leave A Comment?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.