TcHmiSrv
Type Definitions
Name | Description |
|---|---|
ADS route | |
Thread pool size | |
Access level | |
Severity | |
Timing | |
Value type | |
Alarm state | |
Alarm confirmation state | |
Nullable datetime | |
Event type | |
Message | |
Alarm | |
Event | |
Symbol | |
Filter | |
User locale | |
User timezone | |
User groups | |
Event filter |
Webserver
Symbol name | Text | Description |
|---|---|---|
Client-Cache max age | Defines how long server responses may be cached. | |
Cookie expiration date | The server uses cookies to store session IDs. Make sure that the cookie expiration date and the automatic logout duration are not in conflict. | |
Client priority list | IP addresses of preferred clients. If the client limit is reached these clients will be able to connect and clients which are not in this list will be disconnected. | |
Saved sessions | Sessions are saved here so that they are still valid after a server restart. | |
SSDP discovery | Changes will become active after a server restart | |
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 | Timer for persistent connections. | |
Socket timeout | Timeout for incomplete message body. | |
Enable ETAG | The entity tag HTTP header is an identifier for a specific version of a resource. | |
Enable GZIP | GZIP compression is used by the server and web clients to improve transfer speed and bandwidth utilization. | |
GZIP minimum size | Prevents small data from getting zipped. | |
GZIP compression level | GZIP compression is used by the server and web clients to improve transfer speed and bandwidth utilization. | |
Enable PerMessageDeflate | Try to enable compression for all WebSocket requests. Compression is not enabled for clients that don't support it. | |
Enable cache | If enabled, the web-server stores frequently requested data such as web pages, images, and similar media content in RAM to improve response times. | |
Cache max entry size | Server restart required. | |
Cache max size | Server restart required. | |
Cache max age | Server restart required. | |
Global HTTP(S) Headers | These headers will be added to all HTTP responses. | |
Force Revalidation | Works by setting proper Cache-Control, Pragma and Expire headers. | |
MIME HTTP headers | Mappings for internet media types. | |
Default document | This default page is served when a web client requests a URL that points to a directory structure instead of an actual web page within the directory structure. |
General Properties
Symbol name | Text | Description |
|---|---|---|
Project name | The name of the HMI project. | |
Project version | This is the version of the HMI project that has been published to this server. | |
Default Locale | Leave empty to use client locale. | |
Default timezone | Leave empty to use client timezone. | |
Default Time Locale | Leave empty to use client locale. | |
Configurations | The names of all existing configurations. | |
Files | Special handling and permissions for specific files or directories. | |
Virtual directories | Virtual directories are used to specify which folders paths on the file system should be served by the web server. | |
Authentication required | Authentication should only be disabled on private networks. | |
Extensions | Server extensions are used to integrate additional functionality into the server. | |
User groups | User groups have access permissions to specific symbols and files. Permissions are assigned to users based on user groups they are a member of. | |
Members of user groups | The account settings and group memberships of all users from all authentication extensions. | |
Remote Server | Connections to other HMI servers. The mapped symbols of remote servers can be used like symbols from extensions of the current server. | |
Allowed certificates for remote servers | Certificates of the remote servers. |
Advanced
Symbol name | Text | Description |
|---|---|---|
Maximum number of connections | Maximum number of concurrent connections. | |
Size of thread pool | Server restart required. | |
Flood protection | Allowed WebSocket-requests per client IP per second | |
Flood protection HTTP | Allowed HTTP-requests per client IP per second per URI | |
Init timeout | It should not take longer than this to initialize a server extension. | |
Timeout for unloading extensions | It should not take longer than this to unload a server extension. | |
Upload timeout | Upload requests will be rejected if they do not succeed after this duration. | |
Size of chunk packet | Downloaded files will be split into chunks of this size. | |
Size of video segments | HTTP range requests (streamed videos) will be split in chunks of this size. | |
Checksum enabled | Checksum of uploaded files will be validated during publishing. | |
Default logging extension | When the 'ListEvents' function symbol is called, the events are requested from the default event extension. | |
Log diagnostics data for domains | Logging diagnostics data are useful to diagnose problems but they have a negative impact on performance. | |
Maximum connections per client | Keep in mind that web browsers might open multiple simultaneous connections to the same server to achieve faster load times. | |
Maximum size of HTTP header | Requests with HTTP headers that are larger than this limit will be rejected by the web server. | |
Maximum request size | Requests that are larger than this limit will be rejected by the web server. | |
Enable server updates | When server updates are enabled remote servers can be updated to new versions during the publish process. | |
Show configuration hints | Configuration hints inform about problematic settings or combinations of settings in the configurations of the server or server extensions. | |
Disabled configuration hints | Hints which should not be shown anymore. |
Security
Symbol name | Text | Description |
|---|---|---|
Default authentication extension | Multiple authentication extensions can be used at the same time. The default authentication extension is automatically selected on the login page. | |
Select User by | If there are only a few user accounts, selecting the user account using a list box can simplify the login process. | |
Auto logoff | Can be overridden for individual user accounts. This value is used when no other value is specified for the current user. | |
Default user group | All user accounts are automatically added to this user group. | |
Automatic Login | The user account that is configured here is logged in automatically when a new session is opened. | |
Certificate | PEM or PFX formatted certificate. | |
Duration for default certificate | Shorter validity durations limit the damage from key compromise and mis-issuance. Stolen keys and mis-issued certificates are valid for a shorter period of time. | |
Self signed root certificate | This certificate is used to create self-signed server certificates. | |
Self signed root certificate key | This key is used to decrypt the root certificate. | |
Key | This key is used to decrypt the certificate. | |
TempDH | Custom parameters for the Diffie-Hellman (DH) key-exchange. | |
Key Password | Password used to decrypt the private key. | |
Only client certificates allowed to authenticate | Require an approved client certificate to establish a HTTPS connection. | |
Lockout Protection | Enabling client certificate requires a local endpoint. | |
Client Certificates | Client certificates constitute an alternative authentication mechanism that is not based on passwords. | |
SameSite attribute | Specifies whether cookies should be sent for cross-page requests. |
Symbols
Symbol name | Text | Description |
|---|---|---|
Definitions | Storage for JSON schema definitions. | |
Mapped symbols | Mapped symbols are used to grant access to internal symbols of a domain. |