TcHmiSrv

Type definitions

Name	Description
adsRoute	ADS Route
threadPoolSize	Thread pool size
accessEnum	Access level
severity	Severity
timing	Timing
valueType	Data type
alarmState	Alarm state
confirmationState	Alarm confirmation
nullableDateTime	Nullable datetime
eventType	Event type
message	Message
alarm	Alarm
event	Event
symbol	Symbol
filter	Filter
userLocale	Client-Locale
userTimeZone	Client time zone
userGroups	User groups
eventFilter	Event filter

Web server

Symbol name	Text	Description
CLIENT_CACHE_MAX_AGE	Client cache storage duration	Defines how long server responses may be cached.
COOKIEEXPIRATIONDATE	Cookie expiration date	The server uses cookies to store session IDs. Make sure that the cookie expiration date and the time of automatic logout do not contradict each other.
CLIENTPRIORITYLIST	Client prioritization	Ip addresses of prioritized clients. If the client limit is reached, these clients can still connect by disconnecting the connection from clients that are not in the list.
SESSIONSTORAGE	Stored sessions	Sessions are stored here so that they are still valid after a server restart.
DISCOVERY	SSDP Discovery	Change becomes active after server restart
ENDPOINTS	Endpoints	IPv4 and IPv6 endpoints are supported. Only HTTPS endpoints should be enabled for remote access. Use the wildcard addresses '0.0.0.0' and '[::]' to accept remote connections on all network interfaces.
KEEP_ALIVE	Keep alive	Timer for persistent connections.
SOCKET_TIMEOUT	Socket timeout	Timeout for incomplete message body.
ETAGENABLED	ETAG enabled	The entity tag HTTP header is an identification number for a specific version of a resource.
GZIPENABLED	GZIP enabled	GZIP compression is used by the server and web clients to improve transmission speed and bandwidth utilization.
GZIPMINSIZE	GZIP Minimum size	Prevents the compression of small amounts of data.
DEFLATECOMPRESSIONLEVEL	GZIP compression level	GZIP compression is used by the server and web clients to improve transmission speed and bandwidth utilization.
PERMESSAGEDEFLATEENABLED	PerMessageDeflate enabled	Attempts to enable compression for all WebSocket requests. Compression is not enabled for clients that do not support this function.
CACHEENABLED	Cache enabled	If this function is activated, the web server stores frequently requested data such as web pages, images and similar media content in RAM to improve response times.
CACHEMAXENTRYSIZE	Maximum size cache entry	Server restart required.
CACHEMAXSIZE	Maximum cache size	Server restart required.
CACHEMAXAGE	Storage duration of cache entries	Server restart required.
GLOBALHTTPHEADERS	Global HTTP(S) header	These headers are set in all HTTP responses.
REVALIDATION	Force re-validation	Corresponding Cache Control, Pragma and Expire headers are set.
MIME	MIME HTTP headers	Assignments for the Internet Media Type.
DEFAULTDOCUMENT	Default document	This default page is displayed when a web client requests a URL that points to a directory structure instead of an actual web pages within the directory structure.

General properties

Symbol name	Text	Description
PROJECTNAME	Project name	The name of the HMI project.
PROJECTVERSION	Project version	The version of the most recently uploaded HMI project.
DEFAULTLOCALE	Default localization	Leave blank to use the client language setting.
DEFAULTTIMEZONE	Default time zone	Leave blank to use the client time zone setting.
DEFAULTTIMEFORMATLOCALE	Default time localization	Leave blank to use the client language setting.
CONFIGURATIONS	Configurations	The names of all existing configurations.
FILES	Files	Special settings and authorizations for certain files or directories.
VIRTUALDIRECTORIES	Virtual directories	Virtual directories are used to specify which folder paths of the file system are to be made available via the web server.
REQUIREAUTH	Authentication required	Authentication should only be disabled in private networks.
EXTENSIONS	Extensions	Server extensions are used to integrate additional functions into the server.
USERGROUPS	User groups	User groups have access rights to certain symbols and files. Authorizations are assigned to users based on the user groups to which they belong.
USERGROUPUSERS	Group members	The account settings and group memberships of all users of all authentication extensions.
REMOTESERVERS	Remote server	Connections to other HMI servers. The symbol mappings of remote servers can be used like symbols of extensions of the current server.
REMOTESERVERS_CERTIFICATES	Allowed certificates for remote servers	Certificates of the remote servers.

Advanced

Symbol name	Text	Description
MAXSESSIONS	Maximum number of connections	Maximum number of simultaneous connections.
THREADPOOLSIZE	Size of the thread pool	Server restart required.
FLOODPROTECTION	Flood protection	Permitted WebSocket and HTTP requests per client IP per second
HTTP_FLOODPROTECTION	Flood protection HTTP	Allowed HTTP requests per client IP per second per URI
INITTIMEOUT	Timeout when initializing extensions	Initializing a server extension should not take more than this time.
SHUTDOWNTIMEOUT	Timeout when unloading extensions	Unloading a server extension should not take more than this time.
UPLOADTIMEOUT	Upload timeout	Upload requests will be rejected if they are not completed after this period of time.
CHUNKSIZE	Size of a chunk package	When downloading, files are sent in chunks of this size.
VIDEO SEGMENTSIZE	Size of a video segment	HTTP range requests (video streams) are divided into chunks of this size.
CHECKSUMENABLED	Checksum enabled	The checksum of the files is validated during the publish process
DEFAULTEVENTEXTENSION	Default logger extension	When the 'ListEvents' function symbol is called, the events are requested from the default event extension.
DIAGNOSTICS_DOMAINS	Log diagnostic data for domains	Diagnostic messages can be used for error diagnosis. However, this setting has a negative impact on performance.
MAXCONNECTIONSPERCLIENT	Maximum number of connections per client	Please note that web browsers may open several connections to the same server at the same time in order to achieve faster loading times.
MAXHTTPHEADERSIZE	Maximum size of the HTTP header	Requests with HTTP headers that are larger than this limit are rejected by the web server.
MAXREQUESTSIZE	Maximum request size	Requests that exceed this value are rejected by the web server.
ENABLE_SERVER_UPDATE	Enable server updates	Remote servers can be updated to new versions during the publish process if server updates are enabled
SHOW_CONFIGURATION_HINTS	Display configuration hints	Configuration hints provide information about problematic settings or combinations of settings in the configurations of the server or the server extensions.
DISABLED_CONFIGURATION_HINTS	Disabled configuration hints	Configuration hints that should no longer be shown.

Security

Symbol name	Text	Description
DEFAULTAUTHEXTENSION	Default authentication extension	Several authentication extensions can be used at the same time. The default authentication extension is selected by default on the login page.
USERSELECTTYPE	Select users based on	If there are only a few user accounts, selecting the user account via a list box can simplify the login process.
AUTO_LOGOFF	Automatic logoff	Can be overwritten for individual user accounts. This value is used if no other value is specified for the current user. Make sure that the cookie expiration date and the time of automatic logout do not contradict each other.
DEFAULTUSERGROUP	Default user group	All user accounts are automatically added to this user group.
AUTO_LOGINUSER	Automatic login	The user configured here is automatically logged in when a new session is opened.
CERTIFICATE	Certificate	Certificate in PEM or PFX format.
CERTIFICATEEXPIRATION	Validity period for certificates	Shorter validity periods limit the damage caused by key compromise and incorrect issuance. Stolen keys and incorrectly issued certificates are valid for a shorter period of time.
SELFSIGNEDROOTCA	Self-signed root certificate	This certificate is used to create self-signed server certificates.
SELFSIGNEDROOTCAKEY	Self-signed root certificate key	This key is used to decrypt the root certificate.
KEY	Key	This key is used to decrypt the certificate. For certification in PFX format, this field can remain empty.
TEMPDH	TempDH	User-defined parameters for the Diffie-Hellman (DH) key exchange.
KEYPASSWORD	Key password	Password for decoding the private key or the PFX file. If the certificate does not require a password, this field can be left blank.
AUTHCLIENTCERTIFICATE	Authentication only via client certificates	HTTPS connection to the server can only be established by clients with a valid client certificate.
LOCKOUT_PROTECTION_CLIENT_CERTIFICATE	Lockout protection	Activation of client certificates only possible with local endpoint.
CLIENTCERTIFICATES	Client certificates	Client certificates can be used as an alternative authentication mechanism that is not based on passwords.
SAMESITE_ATTRIBUTE	SameSite attribute	Defines whether cookies should be sent with cross-site requests.

Symbols

Symbol name	Text	Description
DEFINITIONS	Definitions	JSON schema definitions are stored here.
SYMBOLS	Symbol mappings	Symbol mapping enables access to the internal symbols of a domain.

Further Information