Description

The TCP listener collects alarms and metrics incoming from a TCP connection and sends the output to 1Gateway. 


Prerequisites

Installation

Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.

1 - Login

Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).

2 - System Maintenance

Click on the menu icon and choose the option "System maintenance"


3 - Upload file


In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.

4 - Restart

After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.

Configuration


Open the main menu and click on "New plugin"

Select the plugin you want to configure. Use the Filter field if needed.

Field name

Supported values

Description

port

Any integer

Port number of the TCP connection

delimiter

Any character

Delimiter used in the fields parameter

Fields

Any string

Message fields separated by <delimiter>

Advanced configuration

The advanced configuration of the TCP listener plugin includes the message type of incoming messsages from a TCP connection to 1Gateway. This message type is used in the mappers used to convert the messages from the TCP connection to normalized metrics.

Image 1: Advanced TCP Listener configuration

See also