Common Settings, Network

Top  Previous  Next

The Common Settings apply to all capture channels.  Once these settings have been specified, OK or Apply should be clicked.  This tab defines up to 999 network capture channels that are specified using a grid.

 

cm4-2comm-net

 

 

Merge Channels

When capturing data from multiple sources, one capture channel is needed for each separate source.  For instance, if GPS data is being captured from 10 vehicles, at least 10 TCP/IP Server channels must be created.

 

To ease administration and set-up, one or more Merge Channels may be set-up combining or consolidating captured data from multiple channels, allowing all data to be displayed in a single window, written to a single log file, and added to a database using a single connection instead of one for each channel.  One record at a time is merged, which may be one or more lines depending on the capture channel 'Line or Record End' setting (there is no record setting for merge channels).  Merge Capture Name are a subset of the network or serial Capture Name, so in the screen capture above the channels named 'TCP Server 1468/1',  'TCP Server 1468/2', etc, are merged to a new channel named 'TCP Server 1468'.

 
Grid Control Buttons

There are five buttons used to manipulate the Network grid:

 

Move Row Up

Used to move the selected row higher up the grid.

Move Row Down

Used to move the selected row lower down the grid.

Add New Row

Causes a new blank row to be added at the bottom of the grid.

Delete Row

Causes the selected row to be permanently deleted.

Copy Row

Causes the selected row to be copied to a new row at the bottom of the grid.

 

For a refresh install, a new blank row is automatically created.  Note that the Network grid scrolls horizontally to show more columns.  To add or edit the grid, click on the required box and an edit control of some sort will appear, perhaps a drop down box arrow, an edit field or numeric up/down arrows.  Once the edit is complete, click on another box to ensure the edit is saved, losing focus from the grid causes the last edit to be cancelled.

 

Capture Name

The Capture Name uniquely identifies this capture channel, and is displayed on the main window tabs and in the information logs.  It may optionally be added to each captured line and may be used as part of the file name for capture logs.  Generally, the name should be as short as possible, while meaningfully describing the purpose of the channel.  Note Capture Names must be unique for Serial Ports as well.

 

Enabled

The Enabled tick box determines whether this channel will be captured.  If unticked, the channel will not appear in the main window.  Its typically used to temporarily disable a channel without deleting it.

 

IP Protocol

 

The IP Protocol is selected from a drop down box with the following options:

 

None

No protocol is specified, the same as not enabling the channel

UDP Server

Listens for incoming UDP datagrams (or packets) on the specified local IP address and port.  Two or more remote computers may send UDP datagrams to the same UDP Server.  Note there no handshaking or error correction with UDP, packets may be lost or become corrupted without ComCap being aware.

TCP Server

Listens for incoming TCP Clients on the specified local IP address and port and negotiates a connection.  A single TCP Server can only accept one connection at a time.  If the connection is broken, the TCP Server may take several minutes before accepting a new TCP Client.  Two or more TCP Server channels (with different Capture Names) may be set-up on the same local IP address and port (use the Copy Row button) and ComCap will assign remote TCP Clients to these channels sequentially, in the order in which they appear in the grid, optionally filtering on Remote IP address, and finally refuse the connection if there are no free TCP Servers.  

TCP Client

Originates a TCP connection to a specified remote TCP Server IP address and port.  Optionally, the connection may be from a specified local IP address and port, but normally it will be a random port which is safer because ports remain in use for a few minutes when closed preventing re-use.  TCP Client is always a single connection to one remote computer.  If the initial connection fails or it drops unexpectedly, it will attempt to connect again according to the Retry Attempts specified below.

 

Windows TCP itself performs several attempts to make a connection, usually failing after about 40 seconds if the TCP Server does not respond.  To reduce this period between attempts, ComCap by default first pings the remote computer with a timeout of only 10 seconds, before making the TCP connection attempt if the computer responds.  The connection may still fail if there is no TCP Server listening, but this normally provided more rapid retry attempts.  In rare cases, ping may be blocked by firewalls or routers, and may be disable in on the LAN/Misc Tab.

 

More information on protocols may be found in the Networking Tutorial.

 

If high speed data is being captured, the TCP/UDP buffer size may be increased, see Network Performance on the Capture Settings Network tab.

 

Service

 

The Service is selected from a drop down box with the following options:

 

Stream

Captured data is considered a continuous stream, not containing any specific service protocol.  It may use any ports.

Syslog

System logging is a service protocol typically used by networking appliances such as routers and firewalls, but also printers and software applications to remotely log data.  Syslog is characterised by lines starting with a number in angle brackets, ie <99> sometimes followed by the data and computer name, the number is decoded by ComCap into facility and severity types that may be used to ignore routine data.  Syslog normally uses UDP Server listening on port 514, but for improved reliability sometimes uses TCP Server on port 1468.

Reliable Syslog

Reliable System Logging is an improved version of Syslog.  It is not currently supported by ComCap and weve not seen any internet appliances using it yet, but it will be supported when a means of testing it is found. .

SNMP

System Network Management Protocol Trap is a binary protocol used by internet appliances, mostly to signal errors and problems.  It uses UDP Server on port 162.  ComCap does not currently decode the binary packets, but this will be added in a forthcoming release.

Avaya RSP

Avaya RSP is a protocol used for telephone logging by Avaya telephone switches which is not supported by ComCap, but will when a means of testing it is found.

 

 

Local IP Address

The Local IP Address is selected from a drop down box that will be filled with all the IP addresses allocated to the computer (at least one, often more on servers) and also 0.0.0.0 which means all IP addresses.  Local IP Address should generally be left as 0.0.0.0 for TCP and UDP Server, for TCP Client it only need to set specifically if the remote TCP Server is expecting connections from a specific IP.

 

Local IP Port

The Local IP Port must always be specified as non-zero for TCP and UDP Server, as a number between 1 and 65,536.  Typically it will be 514 for Syslog, 162 for SNMP.  Only one server can listen on the same port on the same PC, if a port is chosen thats already being used by another application, the TCP or UDP server will fail to open.  For TCP Client, the port is generally left as zero so Windows chooses a random port, but may need to set specifically if the remote TCP Server is expected connections from a specific port.  If defining your own Local IP Port, use a high number between 10,000 and 65,000 to avoid conflicts with other applications.

 

Remote IP Address

For TCP and UDP Server, the Remote IP Address is generally left as 0.0.0.0, meaning any, so connections are accepted from any remote computer.  If multiple server channels are set-up listening on the same local IP address and port, the Remote IP Address may be used as a filter, so specific channels will only accept connections from specific remote IP addresses.  If the multiple server channels are set-up, the first channel must have a 0.0.0.0 Remote IP Address so it can accept connections from anywhere.

 

For TCP Client, the Remote IP Address must be set to that of the remote computer to which a connection should be opened.

 

Remote IP Port

For TCP and UDP Server, the Remote IP Port is generally left as 0.  If a Remote IP Address is specified to filter remote connections to this channel, the Remote IP Port may be specified as non-zero as well to further reduce the filtering to connections from that port.

 

For TCP Client, the Remote IP Port must be set to that of the TCP Server on the remote computer to which a connection should be opened.

 

Filter Information

Filter Information is currently used.

 

Retry Attempts

For TCP Client only, Retry Attempts specifies the number of connection attempts that should be made to the remote computer before failing.  Zero attempts means never stop, but keep retrying for ever, other the maximum attempts is 99.

 

Wait Seconds

For TCP Client only, Wait Seconds specifies the gap between a failed connection and the next retry attempt, with a minimum of 10 seconds and maximum of 300 seconds (five minutes).  Note a connection attempt takes a minimum of 10 seconds, but about 40 seconds if ping is disabled.  The more frequent the connection attempts, the more potential network traffic that is carried, but the lesser probability of lost data.  

 

Channel Id

The Channel Id is fixed data and can not be edited. Ids are allocated sequentially as new network channels are defined, but remain fixed if channels are re-ordered or renamed in the grid.  The Channel Id is used to identify settings in the configuration files comcap.config and comcap.current, ie [NET1], [NET2], etc.

 

Errors

When the OK and Apply buttons are clicked, the Network channels are checked and validated, and may result in the following errors:

 

Config Error: Too Many Channels

A maximum of three network and serial channels is allowed in ComCap Standard Edition, and 999 in the Unlimited Edition.  Disable one or more channels.

Config Error: Local Port Must Not Be Zero

For TCP and UDP Server, the local port may not be zero.

Config Error: Listen must have blank Remote IP and Filter

For multiple TCP and UDP Server channels on the same local IP and port, the first channel must has a 0.0.0.0 remote IP address.

Config Error: Remote IP Address and Port Must Be Specified

For TCP Client, the remote IP address and port must be specified.

Must Specify Network IP Protocol

If the channel is enabled, the IP Protocol can not be none.

Must Specify Network Capture Name

The Capture Name can not be left blank.

Duplicate Capture Name xxx

The Capture Name must be unique between Network and Serial Port channels.

Network Local IP Port Must Not Be Zero for Server

For TCP and UDP Server, the local port may not be zero.

Network Remote IP Port Must Not Be Zero for Client

For TCP Client, the remote IP port may not be zero.

Network Remote IP Address Must Be Specified

For TCP Client, the remote IP address may not be blank.