General Settings

General Settings is a global server configuration property that defines Iotellect Server global parameters that do not belong to any subcategory. Fields of this property are mapped to the server configuration file.

Key name in the configuration file: serverDescription

Value type: String

Possible values: Any printable string

Default value: Textual description of this Iotellect Server instance.

Key name in the configuration file: timezone

Value type: String

Possible values: A list of time zones supported by Java VM

Default value: Time zone set up in the operating system under which Iotellect Server is launched, or GMT if the OS time zone can't be detected. See Dealing with Time Zones for more info.

Key name in the configuration file: serverIp

Value type: String

Possible values: Any valid IP address or empty string

Default value: "" (empty)

If this setting is set to a valid IP address, Iotellect Server listens for incoming connections of Devices, Iotellect Clients and Web UI users only on this IP address. This setting may be useful to run multiple instances of Iotellect Server on a single hardware server that has several IP addresses. In this case, every instance of Iotellect Server will accept incoming connections on the same ports, but on different IP addresses.

Set this setting to a non-empty value only if it's absolutely necessary to accept connections only on a single IP or network interface. For example, if Server IP is set to 192.168.1.5, the Iotellect Client running on the same machine won't be able to connect to the server using localhost address.

Other system services that accept incoming network connections, such as SNMP Trap Listener, use this setting to listen for connections on a certain IP address only.

This IP address is also written as a Destination IP to the External Device Servers that are being connected to the Iotellect Server.

Key name in the configuration file: serverId

Value type: String

Possible values: Any valid alphanumeric string which is unique within a horizontal cluster.

Default value: "" (empty)

String which will uniquely identify the server when using the Cluster Coordinator plugin. Server IDs must be unique within the cluster.

Key name in the configuration file: serverHostName

Value type: String

Possible values: any valid network host name or empty string

Default value: "" (empty)

Value of this option must be either not specified or match DNS name of a machine running Iotellect Server.

If this setting has a value, it is used as an additional alias by the embedded web server.

Also, it is used to access Device Servers that work through HTTP Proxy.

Incorrectly specified server host name may cause various server startup and runtime issues.

Key name in the configuration file: usersSelfRegistration

Value type: Boolean

Possible values: true or false

Default value: true

When enabled, anyone who can access Web UI or an Iotellect Client installation can register a user account, log in and use Iotellect Server. When this option is disabled only registered users with corresponding permissions can add new user accounts.

Key name in the configuration file: configGuiMode

Value type: String

Possible values: yes, no, auto

Default value: auto

This option defines whether the Iotellect Server will make any output to the GUI (Graphical User Interface) of the server. GUI output used includes: Splash Screen at startup, icon in the System Tray, and error message boxes. When this option is disabled, no output to the GUI will be made.

Key name in the configuration file: statisticsFolder

Value type: String

Possible values: Any valid folder path

Default value: statistics

Relative or absolute path of folder that is used for statistical channel data storage.

Key name in the configuration file: clientPort

Value type: Integer

Possible values: 1-65535

Default value: 6460

This option defines the port on which client connections will be accepted.

Key name in the configuration file: nonSecureClientCommunicationEnabled

Value type: Boolean

Possible values: true or false

Default value: false

Allows clients to connect to the Iotellect Server by a plain socket without SSL encryption. Typically should be disabled for security reasons.

Key name in the configuration file: nonSecureClientPort

Value type: Integer

Possible values: 1-65535

Default value: 6461

This option defines the port on which non-secure client connections will be accepted.

Key name in the configuration file: clientEventQueueLength

Value type: Integer

Default value: 100000

This option defines the length of client queue (Events which are waiting to be sent to client). When number of events in this queue reaches this value, Event Delivery Failure is fired in root context of server. All next events will be dropped till the size of queue will reduce.

Key name in the configuration file: netAdminEnabled

Value type: Boolean

Possible values: true or false

Default value: true

This option enables or disables local Telnet access to the Net Admin interface. It is recommended to turn this option off if untrusted users have local (physical or shell) access to the host running Iotellect Server.

Key name in the configuration file: netAdminPort

Value type: Integer

Possible values: 1-65535

Default value: 6440

This option defines the port on which local Net Admin connections will be accepted.

Key name in the configuration file: statisticsFolder

Value type: String

Possible values: Any allowed folder name

Default value: statistics

Relative or absolute path of folder that is used for statistical channel data storage.

Was this page helpful?

Tell us more

Send

Thank you!