Define - TCP Interface Deatils

From the Define - Interfaces: TCP page, click Add or double-click an existing TCP interface, and then the TCP Interface Details page is dispalyed.

The following table describes the items that are available on the TCP Interface Details page:

Items

Description

Name

Type a TCP interface name.

Description

Type a short description for the TCP interface.

Interface ID

Type a TCP interface identifier, which is the internal interface name for Substation ES.

Host (URL)

Type the URL of TCP and the syntax of it is:

host : port

where
  • host is the URL or IP address of the machine on which the Substation ES TCP interface runs.
  • port is the TCP port number.
Use TLS Connection

If you want to perform client authentication, select this check box.

Host Stack Name

Type the IBM stack name to be used with this TCP connection, and a blank value signifies the system default stack.

Trace Level

Enter the TCP interface trace level when tracing payloads that pass through the interface; does not duplicate what is set on the system TRCLVL setting but only shows entries in TCP interface.

The valid values are listed as follows:
  • Levels 1 to level 3: show information mostly useful to users and TIBCO field staff.
  • Levels 4 and 5: show information only useful to engineering staff. The information is detailed and usually specific to internal stacks and control blocks.
Dispatchers

Enter the number of dispatcher worker for the TCP interface.

Valid values for this field are in the range 1 - 40.

The default value is 2.

Workers

Enter the number of concurrent worker subtasks that are started to service Substation ES TCP requests.

Valid values for this field are in the range 1 - 40.

The default value is 2.

WebUI Buffer Size (bytes)

Enter the maximum buffer size for messages returned by TCP Interface to WebUI.

Valid values for this field are in the range 8192 - 128000

The default value is 8192.

Expand the TCP Directives panel, the following items are available:
Connections

Enter the maximum number of open client connections.

Valid values for this field are in the range 1 - 500.

The default value is 5.

Keep Alive

Set whether the keep-alive technique be used to maintain idle connection.

By-default, the check box is selected.

Lazy Retry (sec)

Enter the number of seconds between attempts to reconnect to a disconnected member of a multi-host connection.

Valid values for this field are in the range 1 - 600.

The default value is 60.

Timeout (Sec)

Enter the timeout value in seconds for the main TCP interface-related event loop.

Valid values for this field are in the range 0 - 600.

The default value is 120.

Chunk Buffers

Enter the number of buffers each “chunk of buffers" comprised by the TCP interface’s buffer pool.

Valid values for this field are in the range 1 - 100.

The default value is 32.

Chunk Max Size (bytes)

Enter the maximum number of bytes in each “chunk of buffers" comprised by the TCP interface’s buffer pool.

Valid values for this field are in the range 1024 - 4096000.

The default value is 64000.

Host Log File DDN

Specify the DD name of the data set to which formatted TCP interface log information is written.

The maximum length is 8 characters.

The default value S7RPRINT will be used if no value is specified.

Expand the SSL Directives panel, the following items are available:
TLS Ring File

Specify the Resource Access Control Facility (RACF) key ring name.

It is mandatory if you are using TLS.

TLS Ring Label

(Optional) Specify the RACF identity name.

The default certificate is used to make connections if no value is specified.

TLS Cipher

(Optional) Specify the IBM cipher codes for encryption (for example: 35363738392F303132).

If specified, it overrides the default cipher specification list.

Client Authentication

If you want to perform client authentication, select this check box.

By default, the check box is cleared.

GSK File Name

Specify the name of the USS file to which GSK should write its trace; when GSK File Name and TLS Trace Level are specified, the GSK library’s trace functions are enabled.

TLS Trace Level

Enter the trace level of the messages produced by TLS APIs.

Valid values for this field are in the range 0 - 63.

The default value is 0.