Introduction
ICD-001 is a network communication protocol based on XML. The protocol is used over standard TCP/IP client-server connections.
| Info |
|---|
For customers and integrators intending to use ICD-001, the documents assume a reasonable working knowledge of network communications, XML and XSD. They are targeted at technical teams, typically with software development skills, who are integrating the output from Witness into external systems. |
Overview
When Witness generates events, such as alarms, or processes targets, it passes all this information to the Integration Manager. The Integration Manager is then able to use loaded plugins such as ICD-001 to convert this information into a suitable data format to send to external systems.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
ICD-001 Documentation: |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
On this page:
|
The ICD-001 Plugin
Witness Integration Manager supports integration with many different types of external systems through the use of plugins. These are stand-alone software libraries which are dynamically loaded by the Integration Manager and contain code which knows how to convert the Witness data into the required format for the external system. Navtech Radar can easily develop bespoke plugins to interface with a specific type of equipment or application, however ICD-001 has been developed to provide a comprehensive communication protocol which is based on open standards in order to make it as easy as possible to integrate with a large number of different systems.
The ICD-001 plugin file is entitled Tungsten.Integration.ICD001Highways.Plugin.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 ICD-001 Plugin
When the plugin is installed and licensed, a plugin configuration with default settings is automatically generated. The settings can be viewed and edited through under the Witness Client → Config workspace → Integration plugins folder Config tab > Entity Tree > Integration Configurations, and can be modified as an administrative user.
| Info |
|---|
Once you have made changes to the plugin configuration and committed the changes by saving, the plugin will automatically restart itself based on the new configuration. |
The setting options are as follows:
Enable Plugin
- When not enabled, the plugin will not start up. If the plugin is already running, disabling the plugin will cause it to stop.
Plugin Name
- Name of the plugin within the Witness UI
Track Output Mode
- None - No tracks reports are sent.
- BrokenRule - Report all tracks which have broken rules, regardless of whether this resulted in an alarm.
- AlarmOnly -Report only tracks which have broken rules that results in an active alarm.
- All - Reports all tracks.
Buffer Tracks
- True - Tracks are buffered and sent in batches. This can optimise network load but has the drawback of not sending data in real time. The TrackTransmitInterval setting specifies how often the buffered tracks are sent. (Default)
- False - Tracks are sent as they arrive.
Send Status
- True - Status reports are sent at a regular interval based on the StatusReportInterval.
- False - No status reports are sent. (Default)
Send Alarm
- True - Alarm reports are sent.
- False - No alarm reports are sent. (Default)
Track buffer timer
- Period, in milliseconds, between each batch of tracks being sent. Default is 1000ms (1 second).
Heartbeat timer
- Period, in seconds, between each heartbeat being sent to every connected client. Default is 10 seconds.
Status Report timer
- Period, in seconds, between each status report being sent. Default is 10 seconds.
Monitor Client Health
- True - The plugin monitors the health of client connections. If a client is either not connected or connected but not sending heartbeats, then an alarm will be raised in Witness.
- False - No monitoring is performed.
Related information
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|