# TCP Interface Parameters

The TCP Interface member specifies the TCP Interface parameters so that Substation ES can communicate with Mainframe WebUI through this interface. The TCP Interface member template is stored in the SXSITCP1 file.

If you make a copy of this member, you can point to it by specifying the member name on the `INTFMEMBER` keyword in the main SIP definition member.

The following table lists the TCP Interface parameters supported by Substation ES.

TCP Interface Parameters
Parameter | Description
--- | ---
CHUNK-BUFFERS = {24 | number} | The CHUNK-BUFFERS parameter sets the number of buffers each “chunk of buffers” comprised by the TCP interface’s buffer pool. The valid values range from 2 to 100. The default value is 24.
CHUNK-MAX-SIZE = {64000 | number} | The CHUNK-MAX-SIZE parameter sets the maximum number of bytes in each “chunk of buffers” comprised by the TCP interface’s buffer pool, The valid values range from 1024 to 4096000. The default value is 64000.
CONNECTIONS = {5 | number} | The CONNECTIONS parameter sets the maximum number of open client connections. The valid values range from 5 to 500. The default value is 5.
DESCR = {description} | See DESCR = {description} under "Common Initialization Parameters" above.
DISPATCHERS = {2 | number} | The DISPATCHERS parameter is used to set the number of dispatcher workers for the TCP interface. The valid values range from 1 through 40. The default value is 2.
GSK-FILE = { | name} | The name of the USS file to which GSK should write its trace; when GSK-FILE and GSK-TRCLVL are specified, the GSK library’s trace functions are enabled.
GSK-TRCLVL = {0 | 0-63} | The GSK-TRCLVL parameter specifies the trace level of the messages produced by TLS APIs; when GSK-TRCLVL and GSK-FILE are specified, the GSK library’s trace functions are enabled. The valid values range from 0 to 63. The default value is 0.
INTF-ID = {name} | See INTF-ID = {name} under "Common Initialization Parameters" above.
INTF-TYPE = {number} | See INTF-TYPE = {number} under "Common Initialization Parameters" above.
KEEP-ALIVE = {1 | 0, 1} | The KEEP-ALIVE parameter indicates whether or not the keep-alive technique should be used to maintain idle connections. The valid values are 1 (True) and 0 (False). The default value is 0. It is recommended to set to 1.
LOGFILE-DDN = {S7RPRINT | DDName} | The LOGFILE-DDN parameter specifies the DD name of the data set to which formatted TCP interface log information is written. The number of characters can be from 1 to 8. If you do not specify a value, the default value S7RPRINT applies.
STACK-NAME = { | name} | The IBM stack name to be used with this TCP connection, and a blank value signifies the system default stack.
START-YN = {N | Yes, No} | See START-YN = {Yes, No} under "Common Initialization Parameters" above.
TCPCFG-DDN = {TIBCFG | name} | The TCPCFG-DDN parameter specifies the DD name of the file for storing the TCP configuration definitions of Substation ES. The default name is TIBCFG.
TIMEOUT = {120 | number} | The TIMEOUT parameter sets the timeout in seconds for the main TCP interface-related event loop. The valid values range from 30 to 300. The default value is 120.
TLS-CIPHER = { | name} | (Optional) The IBM cipher codes for encryption (for example: 35363738392F303132); if specified, overrides the default cipher specification list.
TLS-RING-FILE = { | name} | The Resource Access Control Facility (RACF) key ring name; mandatory if using TLS.
TLS-RING-LABEL = { | name} | (Optional) The RACF identity name; if not specified, the default certificate is used to make connections.
TLS-YN = {N | Yes, No} | The TLS-YN parameter specifies whether the TCP Interface will use TLS protocol. The default value is No.
TRCLVL = {0 | 0-5} | The TRCLVL parameter specifies 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 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.
URL = {URL:PORT} | The URL parameter specifies the host name or the IP address and the TCP port that Substation ES exposes for WebUI clients to connect. The TCP port has to be unique on the same LPAR if there are multiple Substation ES running. The default value is a blank space.
WEBUI-BUFFER-SIZE = {8192 | number} | The WEBUI-BUFFER-SIZE parameter sets the maximum buffer size for messages returned by TCP Interface to WebUI. The valid values range from 8192 to 2048000. The default value is 8192 bytes.
WORKERS = {2 | number} | The WORKERS parameter specifies the number of concurrent worker subtasks that are started to service Substation ES TCP requests. The valid values range from 1 through 40. The default value is 2.

Copyright © TIBCO Software Inc. All rights reserved.