The RTS Plugin
Witness Canary supports integration with many different types of external systems through the use of plugins.
The RTS plugin file is entitled Witness.Plugin.RTS.dll and must be present in the Witness Plugin folder which is inside the main application folder.
| Tip |
|---|
The plugin can be selected during setup and will automatically be installed in the correct location. |
Configuring the RTS Plugin
When the plugin is installed and Canary starts, the plugin configuration settings are saved to the PluginConfiguration.xml file. This file is located in the Witness main application folder. To change the settings this file should be opened in a text editor, such as Notepad, however we would recommend an editor which is XML aware, such as Notepad++.
Once the file is open, locate the ICD001 section, as illustrated below:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?>
<Config>
<Plugins>
<RtsInterface>
<PluginConfig>
<RtsServerPort>5000</RtsServerPort>
<RtsServerIPAddress>10.0.9.250</RtsServerIPAddress>
<SenderId>100</SenderId>
<HeartbeatInterval>10</HeartbeatInterval>
<SpeedFactor>1</SpeedFactor>
<TagClassifications>
<TagClassification TagId="124Tag124" Classification="Person" ReplacementTagId="45" />
<TagClassification TagId="122Tag122" Classification="Vehicle" />
<TagClassification TagId="120Tag120" ReplacementTagId="47Operations Vehicle 1" />
</TagClassifications>
</PluginConfig>
</RtsInterface>
</Plugins>
</Config> |
| Info |
|---|
Once you have made changes to the plugin configuration file then you must restart the Canary application / service for the new settings to be applied. No other modules need to be restarted. |
The setting options are as follows:
RtsServerIPAddress
- This is used to configure the RTS Server Address.
RtsServerPort
- The port used for the server.
SenderId
- Sender Id for tracks to appear from
SpeedFactor
- Period, in milliseconds, between each batch of tracks being sent. Default is 1000ms (1 second).
HeartbeatInterval
- Period, in seconds, between each heartbeat being sent to every connected client. Default is 10 seconds.
TagClassifications
- TagId, RTS Tag Id to match on
- Classification, optional Classification for this track to appear as
- ReplacementTagId, optional replacement Tag Id to use