Introduction

ICD-002 is a network communication protocol based on XML. The protocol is used over standard TCP/IP client-server connections. It is used by the Swedish Transport Administration - Trafikverket.

Here is a PDF of the protocol documentation:

Open

This section covers the configuration of the plugin within ClearWay™ to send Alarm Reports. The configuration controls the network settings as well as enabling how and what data is transmitted through the plugin.

Contents

Overview

When ClearWay™ generates events, such as alarms, it passes all this information to the Integration Manager. The Integration Manager is then able to use loaded plugins such as ICD-002 to convert this information into a suitable data format to send to external systems. In this case the plugin converts the data to XML messages which are transmitted over a TCP/IP connection.

The data is transmitted as the events occur, leading to real time reporting.

Configuring the ICD-002 Plugin

The ICD-002 Plugin will appear as a node under the Integration Configurations folder within the Configuration Tree. The settings can be viewed and edited by enabling the Config Function, then selecting the plugin in Integration Configurations, within the Configuration Tree. Configuration settings will then be available in the Configuration Panel. 

Open

Open

The setting options are as follows:

Plugin Enabled: When enabled the plugin will start and will always start when the Witness system starts. When disabled the plugin will stop and will not start until re-enabled.

Name: User friendly name of the plugin.

TCP Port: The TCP port on which the plugin listens to connections from clients.

Max Clients: The total number of network clients supported by the plugin.

System Id: The identification number of the system.

Pump Timer (s): This is how often it will check the timeouts.

Alarm Response Timeout (s): The period of time before an alarm times out.

Alarm Queue Check Interval (s): This setting specifies how often the system checks the Alarm Queue.

Alarm Queue Max Retries: The maximum number of times that the system will check the Alarm Queue before a message is removed. If the setting is set to 0 then the system will keep trying to send the message until it is sent or cleared.

Heartbeat Interval (s): The interval at which heartbeats are sent to the connected clients.

Status Transmission Interval (s): The interval at which the system sends Status reports.

Alarm Severity: The severity is an alarm filter. Only alarms of this severity or higher will be reported. Choose from from Unknown, Friend, Warning or Threat.

Sending ICD-002 Alarm Reports

Because the alarm report message form is based on the standard Witness settings, it may not be immediately obvious what settings to use to send ICD-002 alarms.

In ICD-002, only the following priorities are recognised:

• Low

• Medium

• High

The only alarm type supported is:

• Alarm

The following table provides the equivalent settings for each ICD-002 alarm type:

Status Report

The Status Report documentation is covered in the PDF protocol documentation (located in the Introduction ICD-002 Plugin | Introduction at the top of this page.

Here is an example ICD-002 status report which includes the InUse message and the Type which displays if the sensor is connected:

Related Information